Add warning if CA names length is greater than 30 characters

[adityamittal3107]

No description provided.

[mnk-blr]

✅ 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]

Summary of Changes

Hello @adityamittal3107, 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 introduces a new validation step for custom actions, specifically focusing on the length of action names. It adds a warning system to notify developers when a custom action name surpasses 30 characters, which is a common threshold for optimal UI display. The changes include the core logic for this check, the necessary type exports to support it, and a corresponding unit test to verify its correct behavior.

Highlights

• Custom Action Name Length Warning: Implemented a new warning mechanism that alerts users if a custom action's name exceeds 30 characters, helping to prevent potential UI display or truncation issues.
• Test Coverage: Added a dedicated test case to custom-actions.spec.ts to ensure the new warning functionality for long custom action names works as expected.
• Type Exports: Exported CustomActionsPosition and CustomActionTarget types from all-types-export.ts to make them accessible for broader use within the application.

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. ↩

[gemini-code-assist]

Code Review

This pull request adds a warning when a custom action's name exceeds 30 characters. The implementation is correct and includes a test case. My feedback focuses on improving maintainability by replacing magic numbers with named constants and using a more functional approach for collecting warnings. These changes will make the code easier to read and update in the future.

[gemini-code-assist]

To improve maintainability and readability, it's best to avoid magic numbers. The numbers 31 and 30 should be extracted into a named constant. This makes the test's intent clearer and simplifies future updates if the length limit changes.

While this introduces some duplication with the implementation file, it's a good step. Ideally, this constant would be shared between the implementation and the test file.

        test('should warn when action name length exceeds 30 characters', () => {
            // Arrange
            const MAX_ACTION_NAME_LENGTH = 30;
            const longName = 'A'.repeat(MAX_ACTION_NAME_LENGTH + 1);
            const action: CustomAction = {
                id: 'long-name-id',
                name: longName,
                target: CustomActionTarget.LIVEBOARD,
                position: CustomActionsPosition.PRIMARY,
            };

            // Act
            const result = getCustomActions([action]);

            // Assert
            expect(result.actions).toHaveLength(1);
            expect(logger.warn).toHaveBeenCalledWith([
                `Custom action name '${longName}' exceeds ${MAX_ACTION_NAME_LENGTH} characters. This may cause display or truncation issues in the UI.`
            ]);
        });

[pkg-pr-new]

Open in StackBlitz

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

commit: 44da337

[sonar-prod-ts]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication