SCAL-286360 flag for linkOverride

[yinstardev]

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

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[gemini-code-assist]

Summary of Changes

Hello @yinstardev, 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 implements support for a new enableLinkOverridesV2 flag within the embedding SDK. This flag allows for the activation of an updated link override mechanism in embedded Liveboards. The changes involve modifying the core embedding logic to recognize and apply this new configuration, updating the type definitions, and adding a dedicated test case to ensure proper functionality.

Highlights

• New Feature Flag: Introduced a new enableLinkOverridesV2 boolean parameter to control a new version of link override functionality within embedded Liveboards.
• SDK Integration: The TsEmbed class has been updated to accept and process the enableLinkOverridesV2 parameter, ensuring it is correctly passed as a URL query parameter during embed rendering.
• Type Definition: The BaseViewConfig interface and Param enum in types.ts have been extended to formally define the new enableLinkOverridesV2 property and its corresponding URL parameter key.
• Unit Testing: A new unit test has been added to ts-embed.spec.ts to validate that the enableLinkOverridesV2 parameter is correctly appended to the iframe source URL when set.

🧠 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 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
1 Code Smell

No Coverage information
0.0% Duplication

[pkg-pr-new]

Open in StackBlitz

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

commit: 770965e

[gemini-code-assist]

Code Review

This pull request introduces a new enableLinkOverridesV2 flag for embedding, which is passed as a URL parameter. The implementation is straightforward and includes a new test case to verify the functionality. My review includes a couple of points for consideration. I've raised a concern about the potential for conflict between the new enableLinkOverridesV2 flag and the existing linkOverride flag, suggesting that validation should be added if they are mutually exclusive. I've also recommended improving the JSDoc for the new flag to provide more clarity on its purpose and its interaction with linkOverride.

[gemini-code-assist]

The properties linkOverride and enableLinkOverridesV2 seem related. If they are mutually exclusive, it would be best to add a validation check here to prevent them from being used simultaneously. This would prevent potential unexpected behavior. For example:

if (linkOverride !== undefined && enableLinkOverridesV2 !== undefined) {
    this.handleError({
        errorType: ErrorDetailsTypes.VALIDATION_ERROR,
        message: 'linkOverride and enableLinkOverridesV2 cannot be used together.',
        code: EmbedErrorCodes.CONFLICTING_CONFIG, // You might need to add a new error code
    });
    return queryParams;
}

If they can be used together, please consider updating the documentation for enableLinkOverridesV2 to clarify their interaction.

[gemini-code-assist]

The JSDoc for enableLinkOverridesV2 is quite minimal. To improve clarity for future developers, consider expanding it to explain what 'link overrides V2 functionality' entails. It would also be helpful to clarify its relationship with the existing linkOverride property. For example, should they be used together, or is enableLinkOverridesV2 a replacement for linkOverride? Adding an example would be beneficial as well.