SCAL-277875 Added TSE flag isEnhancedFilterInteractivityEnabled #333
Conversation
…ontroliing isLiveboardPermissionV2Enabled flag
✅ 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. |
Summary of ChangesHello @chinmay-ts, 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 integrates a new feature flag, Highlights
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
|
![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 a new feature flag, isEnhancedFilterInteractivityEnabled. The implementation is mostly correct, but there are a few areas for improvement. A key issue is the naming inconsistency between the SDK flag and the URL parameter, which could cause confusion. Additionally, the new tests have duplicated names and redundant code, which could be refactored into more concise, parameterized tests. Addressing these points will improve the clarity and maintainability of the code.
src/embed/app.spec.ts
Outdated
| test('Should add isLiveboardPermissionV2Enabled flag to the iframe src', async () => { | ||
| const appEmbed = new AppEmbed(getRootEl(), { | ||
| ...defaultViewConfig, | ||
| isEnhancedFilterInteractivityEnabled: true, | ||
| } as AppViewConfig); | ||
| appEmbed.render(); | ||
| await executeAfterWait(() => { | ||
| expectUrlMatchesWithParams( | ||
| getIFrameSrc(), | ||
| `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isLiveboardPermissionV2Enabled=true${defaultParams}${defaultParamsPost}#/home`, | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| test('Should add isLiveboardPermissionV2Enabled flag to the iframe src', async () => { | ||
| const appEmbed = new AppEmbed(getRootEl(), { | ||
| ...defaultViewConfig, | ||
| isEnhancedFilterInteractivityEnabled: false, | ||
| } as AppViewConfig); | ||
| appEmbed.render(); | ||
| await executeAfterWait(() => { | ||
| expectUrlMatchesWithParams( | ||
| getIFrameSrc(), | ||
| `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isLiveboardPermissionV2Enabled=false${defaultParams}${defaultParamsPost}#/home`, | ||
| ); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
There are two tests with the identical name 'Should add isLiveboardPermissionV2Enabled flag to the iframe src'. This is not ideal as it can make test reports confusing. Additionally, these two tests for the true and false cases of the isEnhancedFilterInteractivityEnabled flag can be combined into a single, parameterized test using test.each to reduce code duplication and improve readability. The test name should also reflect the name of the configuration property being tested, which is isEnhancedFilterInteractivityEnabled.
test.each([
{ value: true, expected: 'true' },
{ value: false, expected: 'false' },
])('should add isEnhancedFilterInteractivityEnabled=$value to the iframe src', async ({ value, expected }) => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
isEnhancedFilterInteractivityEnabled: value,
} as AppViewConfig);
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(
getIFrameSrc(),
`http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isLiveboardPermissionV2Enabled=${expected}${defaultParams}${defaultParamsPost}#/home`,
);
});
});
src/embed/liveboard.spec.ts
Outdated
| test('should set isLiveboardPermissionV2Enabled to true in url', async () => { | ||
| const liveboardEmbed = new LiveboardEmbed(getRootEl(), { | ||
| isEnhancedFilterInteractivityEnabled: true, | ||
| ...defaultViewConfig, | ||
| liveboardId, | ||
| } as LiveboardViewConfig); | ||
| liveboardEmbed.render(); | ||
| await executeAfterWait(() => { | ||
| expectUrlMatchesWithParams( | ||
| getIFrameSrc(), | ||
| `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardPermissionV2Enabled=true${prefixParams}#/embed/viz/${liveboardId}`, | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| test('should set isLiveboardPermissionV2Enabled to false in url', async () => { | ||
| const liveboardEmbed = new LiveboardEmbed(getRootEl(), { | ||
| isEnhancedFilterInteractivityEnabled: false, | ||
| ...defaultViewConfig, | ||
| liveboardId, | ||
| } as LiveboardViewConfig); | ||
| liveboardEmbed.render(); | ||
| await executeAfterWait(() => { | ||
| expectUrlMatchesWithParams( | ||
| getIFrameSrc(), | ||
| `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardPermissionV2Enabled=false${prefixParams}#/embed/viz/${liveboardId}`, | ||
| ); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
These two tests for the true and false cases of the isEnhancedFilterInteractivityEnabled flag are very similar and can be combined into a single, parameterized test using test.each. This will reduce code duplication and make the test suite easier to maintain. The test name should also reflect the name of the configuration property being tested, which is isEnhancedFilterInteractivityEnabled.
test.each([
{ value: true, expected: 'true' },
{ value: false, expected: 'false' },
])('should set isEnhancedFilterInteractivityEnabled=$value in url', async ({ value, expected }) => {
const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
isEnhancedFilterInteractivityEnabled: value,
...defaultViewConfig,
liveboardId,
} as LiveboardViewConfig);
liveboardEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(
getIFrameSrc(),
`http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardPermissionV2Enabled=${expected}${prefixParams}#/embed/viz/${liveboardId}`,
);
});
});
commit: |
|
SonarQube Quality Gate
|
No description provided.