[SCAL-302340] - Add support for spotterSidebarConfig in AppEmbed and SpotterEmbed APP_INIT payloads

[ravishah8176]

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 significantly enhances the embedding capabilities for ThoughtSpot applications by introducing a dedicated configuration object for the Spotter sidebar. This change provides developers with more control over the embedded experience, ensuring consistency and flexibility in how the AI conversation features are presented. It also includes robust handling for a deprecated configuration flag and validation for URL inputs, improving the overall reliability and maintainability of the embed SDK.

Highlights

• Enhanced Spotter Sidebar Configuration: Introduced support for a new spotterSidebarConfig object within the APP_INIT payloads for both AppEmbed and SpotterEmbed. This allows for granular control over the Spotter sidebar's behavior and appearance, including its title, default expansion state, and past conversations feature.
• Deprecation Handling for enablePastConversationsSidebar: Implemented logic to gracefully handle the transition from a standalone enablePastConversationsSidebar flag to its inclusion within spotterSidebarConfig. The new configuration object takes precedence, but the standalone flag is used as a fallback if the new config omits the property.
• URL Validation for spotterDocumentationUrl: Added validation for the spotterDocumentationUrl property within spotterSidebarConfig. Invalid URLs will trigger an error and be omitted from the APP_INIT payload, ensuring data integrity and preventing malformed links.
• New APP_INIT Data Interfaces: Defined new TypeScript interfaces, AppEmbedAppInitData and SpotterAppInitData, to explicitly type the structure of the APP_INIT payload, including the new embedParams.spotterSidebarConfig.
• Comprehensive Test Coverage: Added extensive unit tests for both AppEmbed and SpotterEmbed to verify the correct parsing, precedence, and validation of spotterSidebarConfig and the deprecated enablePastConversationsSidebar flag in the APP_INIT 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 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.

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 adds support for spotterSidebarConfig in AppEmbed and SpotterEmbed APP_INIT payloads. The implementation is generally good, but I've identified a few areas for improvement. There's a potential runtime error in both AppEmbed and SpotterEmbed when constructing embedParams due to spreading a potentially undefined value. I've suggested fixes for this. Additionally, there's significant code duplication between AppEmbed and SpotterEmbed for processing spotterSidebarConfig, which I recommend refactoring into a shared utility function for better maintainability. Lastly, I've noted that the test suite for AppEmbed is missing a case for handling an invalid spotterDocumentationUrl, which is already covered for SpotterEmbed.

[pkg-pr-new]

Open in StackBlitz

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

commit: 0d7c71c

[sonar-prod-ts]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication