[SCAL-289371] - feat(spotter): add sidebar embed actions, events, params, and CSS variables #402
Conversation
…ams, and CSS variables - Add 9 new Action enum entries for Spotter sidebar controls - Add 3 new EmbedEvent entries for conversation lifecycle events - Add 9 new Param enum entries and SpotterEmbedViewConfig properties - Add 12 new CSS variables for saved chats sidebar theming
Summary of ChangesHello @ravishah8176, I'm Gemini Code Assist1! 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 customization capabilities of the Spotter past conversations sidebar within the SDK. It provides developers with extensive control over the sidebar's appearance, behavior, and interactive elements through new CSS variables, embed configuration parameters, and action controls. Additionally, it introduces new events to allow external applications to react to key conversation lifecycle changes, such as renaming, deleting, or selecting a chat. Highlights
🧠 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. Using Gemini Code AssistThe 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
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 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
|
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
SonarQube Quality Gate
|
commit: |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces extensive customization options for the Spotter past conversations sidebar, adding new actions, events, parameters, and CSS variables to control its appearance and behavior. However, a critical security vulnerability has been identified: new string-based configuration options are used to construct a URL without proper encoding, leading to a high-risk Cross-Site Scripting (XSS) and HTTP Parameter Pollution vulnerability. This could allow attackers to inject malicious JavaScript or manipulate URL parameters, potentially compromising user accounts. It is crucial to properly encode all user-provided values before they are used in the URL. Additionally, there's a suggestion to refactor a series of if statements to improve code maintainability.
| if (!isUndefined(spotterSidebarTitle)) { | ||
| queryParams[Param.SpotterSidebarTitle] = spotterSidebarTitle; | ||
| } | ||
|
|
||
| if (!isUndefined(spotterSidebarDefaultExpanded)) { | ||
| queryParams[Param.SpotterSidebarDefaultExpanded] = !!spotterSidebarDefaultExpanded; | ||
| } | ||
|
|
||
| if (!isUndefined(spotterChatRenameLabel)) { | ||
| queryParams[Param.SpotterChatRenameLabel] = spotterChatRenameLabel; | ||
| } | ||
|
|
||
| if (!isUndefined(spotterChatDeleteLabel)) { | ||
| queryParams[Param.SpotterChatDeleteLabel] = spotterChatDeleteLabel; | ||
| } | ||
|
|
||
| if (!isUndefined(spotterDeleteConversationModalTitle)) { | ||
| queryParams[Param.SpotterDeleteConversationModalTitle] = spotterDeleteConversationModalTitle; | ||
| } | ||
|
|
||
| if (!isUndefined(spotterPastConversationAlertMessage)) { | ||
| queryParams[Param.SpotterPastConversationAlertMessage] = spotterPastConversationAlertMessage; | ||
| } | ||
|
|
||
| if (!isUndefined(spotterDocumentationUrl)) { | ||
| queryParams[Param.SpotterDocumentationUrl] = spotterDocumentationUrl; | ||
| } | ||
|
|
||
| if (!isUndefined(spotterBestPracticesLabel)) { | ||
| queryParams[Param.SpotterBestPracticesLabel] = spotterBestPracticesLabel; | ||
| } | ||
|
|
||
| if (!isUndefined(spotterConversationsBatchSize)) { | ||
| queryParams[Param.SpotterConversationsBatchSize] = spotterConversationsBatchSize; | ||
| } |
There was a problem hiding this comment.
The new string properties added to SpotterEmbedViewConfig (e.g., spotterDocumentationUrl, spotterSidebarTitle, etc.) are incorporated into the iframe's source URL without proper URL encoding. This creates a high-risk Cross-Site Scripting (XSS) and HTTP Parameter Pollution vulnerability. Specifically, spotterDocumentationUrl is dangerous as a javascript: URI could execute arbitrary JavaScript, and other string parameters allow injection of special characters like &, =, and #. All user-provided string values must be explicitly URL-encoded before being assigned to queryParams, and spotterDocumentationUrl should also have protocol validation (allowing only http: and https:). Additionally, to improve maintainability and reduce code repetition, consider refactoring these consecutive if statements into a more data-driven approach using an array and a loop to handle adding parameters to queryParams.
const sidebarParams: { key: keyof SpotterEmbedViewConfig; param: Param; isBoolean?: boolean }[] = [
{ key: 'spotterSidebarTitle', param: Param.SpotterSidebarTitle },
{ key: 'spotterSidebarDefaultExpanded', param: Param.SpotterSidebarDefaultExpanded, isBoolean: true },
{ key: 'spotterChatRenameLabel', param: Param.SpotterChatRenameLabel },
{ key: 'spotterChatDeleteLabel', param: Param.SpotterChatDeleteLabel },
{ key: 'spotterDeleteConversationModalTitle', param: Param.SpotterDeleteConversationModalTitle },
{ key: 'spotterPastConversationAlertMessage', param: Param.SpotterPastConversationAlertMessage },
{ key: 'spotterDocumentationUrl', param: Param.SpotterDocumentationUrl },
{ key: 'spotterBestPracticesLabel', param: Param.SpotterBestPracticesLabel },
{ key: 'spotterConversationsBatchSize', param: Param.SpotterConversationsBatchSize },
];
sidebarParams.forEach(({ key, param, isBoolean }) => {
const value = this.viewConfig[key];
if (!isUndefined(value)) {
queryParams[param] = isBoolean ? !!value : value;
}
});
Add SDK support for Spotter past conversations sidebar customization:
SpotterSidebarHeader,SpotterNewChat,SpotterChatRename, etc.)SpotterConversationRenamed,SpotterConversationDeleted,SpotterConversationSelected)Version: SDK 1.46.0 | ThoughtSpot 26.3.0.cl