SCAL-265064 : dynamic pre render

[sastaachar]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @sastaachar, 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 enhances the TsEmbed component by adding an event notification mechanism during the pre-rendering setup. This change aims to support more dynamic pre-rendering scenarios by allowing other parts of the system to react to updates in the view configuration as it's being prepared for rendering.

Highlights

• Eventing: Introduced a new event trigger, updateEmbedParams, within the TsEmbed class. This event is dispatched immediately after the viewConfig is validated for pre-rendering, passing the viewConfig object as a payload.

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

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 event trigger, updateEmbedParams, to support dynamic updates for pre-rendered components. The review identifies a high-severity issue with the implementation of the event trigger, which uses a magic string and as any, bypassing type safety. A recommendation is provided to define this new event in the HostEvent enum for better maintainability and correctness.

[gemini-code-assist]

Using a magic string 'updateEmbedParams' with as any bypasses TypeScript's type safety and makes the code harder to maintain. This approach is error-prone and makes it difficult for other developers to discover and use this event correctly.

It is strongly recommended to add a new member to the HostEvent enum in src/types.ts for this event. For example:

// in src/types.ts
export enum HostEvent {
    // ... existing events
    UpdateEmbedParams = 'updateEmbedParams',
}

This will make the code type-safe, more readable, and easier to maintain.

Suggested change

	this.trigger('updateEmbedParams' as any, this.viewConfig);
	this.trigger(HostEvent.UpdateEmbedParams, this.viewConfig);

[pkg-pr-new]

Open in StackBlitz

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

commit: 413230f

[mnk-blr]

🎉 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)

[sonar-prod-ts]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots ( 100.0% reviewed)
2 Code Smells

No Coverage information
0.0% Duplication