Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add a warning icon and tooltip to indicate empty datasources #33618

Merged
merged 6 commits into from
May 23, 2024

Conversation

AmanAgarwal041
Copy link
Contributor

@AmanAgarwal041 AmanAgarwal041 commented May 21, 2024

Description

Indicate the warning icon and display tooltip on hover of the sidebar datasource icon if no datasource is created in the current workspace, to nudge the users to create one.

Notion doc : https://www.notion.so/appsmith/Nudge-for-users-to-connect-their-own-datasource-c62b5194bae84383b6301e4fe2e3ad80#d9a140a4bbda4ed18ac95136990aa3e6
Figma : https://www.figma.com/design/kbU9xPv44neCfv1FFo9Ndu/User-Activation?node-id=5303-26410&t=skXEhNbpopbw1gYs-0

Fixes #30522
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.IDE"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9203050102
Commit: 6bb71c4
Cypress dashboard url: Click here!

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Copy link
Contributor

coderabbitai bot commented May 21, 2024

Walkthrough

The recent changes enhance the app's sidebar functionality to address users who skip connecting a datasource. A new tooltip and icon now indicate the absence of a connected datasource, ensuring users are informed about the missing configuration. These updates involve modifications to constants, component props, and logic for conditional rendering to support the new visual cues and messages.

Changes

Files/Paths Change Summary
.../constants/messages.ts Updated EMPTY_DATASOURCE_TOOLTIP_SIDEBUTTON with a message function for datasource connection guidance.
.../entities/IDE/constants.ts Added SideButtonType enum, updated SidebarButton interface with conditionType and conditionTooltip fields.
.../Editor/IDE/Sidebar/SidebarButton.test.tsx Added a test case for rendering SidebarButton with specific props.
.../Editor/IDE/Sidebar/SidebarButton.tsx Enhanced SidebarButton component to include conditionIcon prop, adjusted component structure for this feature.
.../Editor/IDE/Sidebar/SidebarComponent.tsx Introduced imports for SideButtonType, useSelector, and getDatasources. Implemented getConditionalIconAndTooltip function.

Assessment against linked issues

Objective Addressed Explanation
Indicate the absence of a connected datasource with a visual hint and tooltip (Issue #30522)
Change the Data icon and add a tooltip on hover when no datasource is connected (Issue #30522)
Ensure new constants and enums are introduced for the new functionality (Issue #30522)
Update the SidebarButton component to support new props for condition icons and tooltips (Issue #30522)
Add conditional rendering logic based on datasource connection status (Issue #30522)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added BE Coders Pod Issues related to users writing code to fetch and update data Integrations Pod Issues related to a specific integration Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Task A simple Todo Bug Something isn't working labels May 21, 2024
@AmanAgarwal041 AmanAgarwal041 added the ok-to-test Required label for CI label May 21, 2024
@AmanAgarwal041
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

@AmanAgarwal041 AmanAgarwal041 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 22, 2024
Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9189021875.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33618.
recreate: .

Copy link

Deploy-Preview-URL: https://ce-33618.dp.appsmith.com

sneha122
sneha122 previously approved these changes May 22, 2024
@AmanAgarwal041 AmanAgarwal041 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 22, 2024
@AmanAgarwal041 AmanAgarwal041 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 22, 2024
@AmanAgarwal041 AmanAgarwal041 removed the ok-to-test Required label for CI label May 22, 2024
@AmanAgarwal041 AmanAgarwal041 added the ok-to-test Required label for CI label May 22, 2024
@rohan-arthur
Copy link
Contributor

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9202443250.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33618.
recreate: .

Copy link

Deploy-Preview-URL: https://ce-33618.dp.appsmith.com

@AmanAgarwal041 AmanAgarwal041 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 23, 2024
@AmanAgarwal041 AmanAgarwal041 merged commit d070ca7 into release May 23, 2024
50 of 71 checks passed
@AmanAgarwal041 AmanAgarwal041 deleted the fix/30522-datasource-icon branch May 23, 2024 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BE Coders Pod Issues related to users writing code to fetch and update data Bug Something isn't working Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Integrations Pod Issues related to a specific integration ok-to-test Required label for CI Task A simple Todo
Projects
None yet
3 participants