-
Notifications
You must be signed in to change notification settings - Fork 6
SCAL-266892 : fix for pre render without liveboard id , wait for navigate event #274
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.
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
Conversation
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @sastaachar, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a timing issue in the Liveboard embedding process, particularly during pre-rendering. It ensures that navigation to a Liveboard, Viz, or specific tab only occurs after the embedded container is fully loaded and ready to receive events. This improves the reliability of pre-rendered Liveboard experiences and allows for more granular control over the target content.
Highlights
- Enhanced Pre-render Navigation Logic: The
beforePrerenderVisible
method inLiveboardEmbed
now defers navigation until the embedded container signals its readiness, preventing issues with premature navigation on an uninitialized iframe. - New Embed Container Readiness Mechanism: A new mechanism has been introduced in the base
TsEmbed
class, includingisEmbedContainerLoaded
state andexecuteAfterEmbedContainerLoaded
callback queue, to manage and react to the embedded iframe's readiness. - New
EmbedListenerReady
Event: A newEmbedEvent.EmbedListenerReady
event has been added to explicitly signal when the embedded application is fully initialized and ready to handle events, providing a more robust readiness signal than the previousAuthInit
fallback. - Extended Liveboard Navigation Parameters: The
navigateToLiveboard
method now acceptsvizId
andactiveTabId
in addition toliveboardId
, allowing for more precise deep-linking within Liveboards.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a mechanism for handling asynchronous embed container loading, improving stability in pre-rendering scenarios. The changes are well-implemented, and the tests are comprehensive, covering various states and edge cases. A few suggestions are included to further enhance code quality and maintainability.
import * as processTriggerInstance from '../utils/processTrigger'; | ||
import * as auth from '../auth'; | ||
import * as previewService from '../utils/graphql/preview-service'; | ||
import * as SessionInfoService from '../utils/sessionInfoService'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
embedObj.currentLiveboardState = { | ||
liveboardId: this.viewConfig.liveboardId, | ||
vizId: this.viewConfig.vizId, | ||
activeTabId: this.viewConfig.activeTabId, | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
src/embed/ts-embed.ts
Outdated
// Wait for 1 second to ensure the embed container is loaded | ||
// This is a workaround to ensure the embed container is loaded | ||
// this is needed until all clusters have EmbedListenerReady event | ||
setTimeout(processEmbedContainerReady, 1000); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
callback?.(); | ||
} else { | ||
logger.debug('pushing callback to embedContainerReadyCallbacks', callback); | ||
this.embedContainerReadyCallbacks.push(callback); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since callback is requried field why would it be null ?
commit: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No description provided.