Skip to content

Conversation

@ShashiSubramanya
Copy link
Contributor

  • Replaced Worksheet terminology with Model
  • Updated description text for HostEvent.GetIframeUrl as per SCAL-278257

@ShashiSubramanya ShashiSubramanya requested a review from a team as a code owner October 17, 2025 09:09
@mnk-blr
Copy link
Collaborator

mnk-blr commented Oct 17, 2025

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

Status Scanner Critical High Medium Low Total (0)
Licenses 0 0 0 0 0 issues
Open Source 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
Copy link

Summary of Changes

Hello @ShashiSubramanya, 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 primarily focuses on refining the codebase's terminology by consistently replacing 'Worksheet' with 'Model' to ensure uniformity across the application's interfaces and documentation. Additionally, it includes a minor but important documentation update for the HostEvent.GetIframeUrl method, improving its clarity and general applicability.

Highlights

  • Terminology Update: Replaced instances of 'Worksheet' with 'Model' across various configurations, error messages, and documentation to standardize terminology within the codebase.
  • Documentation Clarification: Updated the description for HostEvent.GetIframeUrl to be more concise and remove a specific reference to 'playground', aligning with SCAL-278257.
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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the terminology from 'Worksheet' to 'Model' across various files and also updates a description for HostEvent.GetIframeUrl. The changes are mostly in comments and string literals. I've noticed a few places where property or constant names were not updated, leading to inconsistencies between the code and its documentation. I've left specific comments with suggestions to address these for better code clarity and maintainability. I also found a typo in a constant name.

* The ID of the worksheet to use for the conversation.
* The ID of the Model to use for the conversation.
*/
worksheetId: string;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While the comment at line 13 was updated to use the term 'Model', the property name worksheetId remains unchanged, creating an inconsistency. To fully align with the terminology update across the SDK, consider renaming this property to modelId. This would likely be a breaking change and require updates in other parts of the codebase where this property is used, such as in the SpotterAgentEmbed and ConversationService classes.

* Disable the data source selection option.
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
*/
disableWorksheetChange?: boolean;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The property name disableWorksheetChange is inconsistent with its updated comment which refers to 'data source'. For consistency with the terminology update, consider renaming this to disableDataSourceChange. This would be a breaking change requiring updates where it's used, including the Param enum.

* Hide the data source selection panel.
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
*/
hideWorksheetSelector?: boolean;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similar to disableWorksheetChange, the property name hideWorksheetSelector is inconsistent with its updated comment. Consider renaming it to hideDataSourceSelector for consistency. This would also be a breaking change.

/**
* Show or hide sample questions.
* The sample questions are autogenerated based on the worksheet
* The sample questions are autogenerated based on the data Model.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase 'data Model.' is grammatically incorrect with the trailing period and could be more concise. For consistency with other terminology changes, consider using just 'Model'. This also resolves the grammatical error.

Suggested change
* The sample questions are autogenerated based on the data Model.
* The sample questions are autogenerated based on the Model

export const ERROR_MESSAGE = {
INVALID_THOUGHTSPOT_HOST: 'Error parsing ThoughtSpot host. Please provide a valid URL.',
SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND: 'Please select a worksheet to get started',
SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND: 'Please select a Model to get started',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This key has a typo ('WORKSHEED' should be 'WORKSHEET'). Given the terminology update, it would be more consistent to rename the key to SPOTTER_EMBED_MODEL_ID_NOT_FOUND.

Suggested change
SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND: 'Please select a Model to get started',
SPOTTER_EMBED_MODEL_ID_NOT_FOUND: 'Please select a Model to get started',

@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 17, 2025

Open in StackBlitz

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

commit: d1cb934

@sonar-prod-ts
Copy link

sonar-prod-ts bot commented Oct 21, 2025

SonarQube Quality Gate

Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@ShashiSubramanya ShashiSubramanya merged commit c2da3fd into main Oct 22, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants