Reload global function

[adityamittal3107]

No description provided.

[mnk-blr]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Licenses	0	0	0	0	0 issues
✅	Open Source Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[gemini-code-assist]

Summary of Changes

Hello @adityamittal3107, I'm Gemini Code Assist¹! 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 introduces a new global function, reloadIframe, within the embedding base module. This function provides a standardized way to programmatically trigger a reload of an embedded ThoughtSpot iframe, enhancing control and flexibility for applications integrating ThoughtSpot. It abstracts the underlying reload mechanism, making it easier to maintain and use.

Highlights

• New Global Function: A new global function, reloadIframe, has been introduced in src/embed/base.ts.
• Iframe Reload Capability: This new function allows for the programmatic reloading of a ThoughtSpot iframe by utilizing an internal reload utility.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new global function, reloadIframe, which wraps an internal reload utility to allow consumers of the SDK to reload a ThoughtSpot iframe. The change is straightforward and useful. My feedback includes a suggestion to make the new function more robust by handling cases where an invalid iframe element is passed, and a recommendation to add unit tests to ensure the feature is reliable and maintainable.

[gemini-code-assist]

The new reloadIframe function is a valuable addition to the public API. However, it's crucial to add unit tests for it in src/embed/base.spec.ts to ensure its functionality is verified and to prevent future regressions. Please add tests that cover the successful reload scenario and also how it behaves when an invalid iFrame is passed.

[gemini-code-assist]

For robustness in this public-facing SDK function, it's good practice to add a check to ensure the iFrame argument is not null or undefined before attempting to use it. This prevents potential runtime errors if the function is called with an invalid argument, especially from JavaScript code.

Suggested change

	export const reloadIframe = (iFrame: HTMLIFrameElement) => {
	reload(iFrame);
	};
	export const reloadIframe = (iFrame: HTMLIFrameElement) => {
	if (!iFrame) {
	logger.warn('reloadIframe called with no iFrame element.');
	return;
	}
	reload(iFrame);
	};

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/thoughtspot/visual-embed-sdk/@thoughtspot/visual-embed-sdk@345

commit: b18a6e2

[sonar-prod-ts]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication