[SCAL-295746] add muze chart ga flag to embed params

[rachitshukla-ts]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello, 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 configuration flag to enable or disable the first phase of Muze charts in General Availability for embedded ThoughtSpot applications. By allowing this flag to be passed through embed parameters, it provides granular control over this feature's availability within various embedded contexts, ensuring consistent behavior and facilitating feature rollout.

Highlights

• New Feature Flag: Introduced a new feature flag, muzeChartPhase1EnabledGA, to control the enablement of Muze chart phase 1 General Availability within embedded applications.
• Embed Component Integration: The muzeChartPhase1EnabledGA flag has been integrated into AppEmbed, LiveboardEmbed, and SearchEmbed components, allowing it to be passed as a configuration option.
• URL Parameter Propagation: The flag's value is now correctly propagated as a query parameter in the iframe source URL for all affected embed types, ensuring the embedded application receives the configuration.
• Comprehensive Testing: Added new and updated existing test cases across app.spec.ts, liveboard.spec.ts, and search.spec.ts to verify the correct behavior and URL parameter generation for the muzeChartPhase1EnabledGA flag.
• Documentation Update: Updated SearchViewConfig and LiveboardAppEmbedViewConfig with JSDoc comments for the new muzeChartPhase1EnabledGA property, including supported embed types, versioning, default value, and usage examples.

Changelog

• src/embed/app.spec.ts
  • Added three new test cases to verify that the muzeChartPhase1EnabledGA parameter is correctly added to the iframe source URL when set to true, false, or not specified.
• src/embed/app.ts
  • Added muzeChartPhase1EnabledGA as an optional parameter to the AppEmbed constructor.
  • Implemented logic to conditionally add muzeChartPhase1EnabledGA to the URL query parameters if it is defined.
• src/embed/liveboard.spec.ts
  • Added two new test cases to verify that the muzeChartPhase1EnabledGA parameter is correctly added to the iframe source URL when set to true or false.
• src/embed/liveboard.ts
  • Added muzeChartPhase1EnabledGA as an optional parameter to the LiveboardEmbed constructor.
  • Implemented logic to conditionally add muzeChartPhase1EnabledGA to the URL query parameters if it is defined.
• src/embed/search.spec.ts
  • Added two new test cases to verify that the muzeChartPhase1EnabledGA parameter is correctly added to the iframe source URL when set to true or false.
• src/embed/search.ts
  • Added muzeChartPhase1EnabledGA as an optional property to the SearchViewConfig interface with JSDoc documentation.
  • Destructured muzeChartPhase1EnabledGA from this.viewConfig in SearchEmbed.
  • Implemented logic to conditionally add muzeChartPhase1EnabledGA to the URL query parameters if it is defined.
• src/types.ts
  • Added muzeChartPhase1EnabledGA as an optional property to the LiveboardAppEmbedViewConfig interface with comprehensive JSDoc documentation.
  • Added MuzeChartPhase1EnabledGA to the Param enum to represent the new URL parameter key.

Activity

• No human activity has been recorded on this pull request yet.

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

[sonar-prod-ts]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

No Coverage information
0.0% Duplication

[pkg-pr-new]

Open in StackBlitz

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

commit: b885e18

[gemini-code-assist]

Code Review

This pull request introduces the muzeChartPhase1EnabledGA feature flag across AppEmbed, LiveboardEmbed, and SearchEmbed. The implementation is largely correct, with new tests added to verify the behavior. My review includes suggestions to improve code consistency by using an existing utility function and to enhance test coverage by adding test cases for when the new flag is not specified.

[ruchI9897]

LGTM

[shivam-kumar-ts]

How this can possible

[shivam-kumar-ts]

How this can possible