SCAL-291756: Embed params to disable and hide spotter chat components

[somechandra-thoughtspot]

No description provided.

[mnk-blr]

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

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues
✅	Code 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 @somechandra-thoughtspot, 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 embedding capabilities by introducing new configuration options for the Spotter chat interface. Developers can now specify parameters to either disable interaction with or completely hide various chat components, such as connector resources, connectors, and the mode switcher. This provides greater flexibility in customizing the embedded experience to meet specific application requirements.

Highlights

• New Embed Parameters for Spotter Chat: Introduced new spotterChatConfig parameters to control the visibility and interactivity of Spotter chat components: disableChatConnectorResources, disableChatConnectors, disableChatModeSwitcher, hideChatConnectorResources, hideChatConnectors, and hideChatModeSwitcher.
• Expanded Configuration Options: Updated the SpotterChatViewConfig interface to include these new properties, allowing fine-grained control over chat connector resources, chat connectors, and the chat mode switcher within embedded applications.
• Parameter Propagation: Ensured that these new configuration parameters are correctly extracted from spotterChatConfig and propagated as URL query parameters for AppEmbed, SpotterEmbed, and LiveboardEmbed instances.
• Comprehensive Testing: Added extensive unit tests across app.spec.ts, conversation.spec.ts, and liveboard.spec.ts to verify the correct handling and URL parameter generation for all new disable and hide options.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• src/embed/app.spec.ts
  • Added new test cases to verify the correct propagation of disableChatConnectorResources, disableChatConnectors, disableChatModeSwitcher, hideChatConnectorResources, hideChatConnectors, and hideChatModeSwitcher parameters via spotterChatConfig in AppEmbed.
• src/embed/app.ts
  • Implemented logic to extract and set new spotterChatConfig parameters (disableChatConnectorResources, disableChatConnectors, disableChatModeSwitcher, hideChatConnectorResources, hideChatConnectors, hideChatModeSwitcher) into the URL for AppEmbed.
• src/embed/conversation.spec.ts
  • Added new test cases to verify the correct propagation of disableChatConnectorResources, disableChatConnectors, disableChatModeSwitcher, hideChatConnectorResources, hideChatConnectors, and hideChatModeSwitcher parameters via spotterChatConfig in SpotterEmbed, including a test for multiple options.
• src/embed/conversation.ts
  • Updated the SpotterChatViewConfig interface documentation and added new properties (disableChatConnectorResources, disableChatConnectors, disableChatModeSwitcher, hideChatConnectorResources, hideChatConnectors, hideChatModeSwitcher) to allow configuration of Spotter chat component visibility and interactivity.
  • Implemented logic to extract and set these new parameters into the URL for SpotterEmbed.
• src/embed/liveboard.spec.ts
  • Added new test cases to verify the correct propagation of disableChatConnectorResources, disableChatConnectors, disableChatModeSwitcher, hideChatConnectorResources, hideChatConnectors, and hideChatModeSwitcher parameters via spotterChatConfig in LiveboardEmbed.
• src/embed/liveboard.ts
  • Implemented logic to extract and set new spotterChatConfig parameters (disableChatConnectorResources, disableChatConnectors, disableChatModeSwitcher, hideChatConnectorResources, hideChatConnectors, hideChatModeSwitcher) into the URL for LiveboardEmbed.
• src/types.ts
  • Added new enum members to Param for DisableChatConnectorResources, DisableChatConnectors, DisableChatModeSwitcher, HideChatConnectorResources, HideChatConnectors, and HideChatModeSwitcher.

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

[pkg-pr-new]

Open in StackBlitz

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

commit: 2e6a04f

[gemini-code-assist]

Code Review

This pull request introduces new spotterChatConfig options to control the visibility and interactivity of chat connector resources, chat connectors, and the chat mode switcher within embedded applications. The changes involve updating the SpotterChatViewConfig interface, adding new URL parameters, and implementing the logic to pass these configurations as URL parameters in AppEmbed, SpotterEmbed, and LiveboardEmbed classes. Corresponding unit tests were added for AppEmbed, SpotterEmbed, and LiveboardEmbed to verify these parameters are correctly applied. The reviewer noted that the new tests in app.spec.ts and liveboard.spec.ts contain significant code duplication and suggested refactoring them to use test.each for improved maintainability and readability, mirroring the approach already used in conversation.spec.ts.

[sonar-prod-ts]

SonarQube Quality Gate

14.06% Duplicated Lines (%) on New Code (is greater than 3%)

See analysis details on SonarQube