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

feat: Disabled datasource selector in query pages #36940

Merged
merged 9 commits into from
Oct 25, 2024

Conversation

albinAppsmith
Copy link
Collaborator

@albinAppsmith albinAppsmith commented Oct 17, 2024

Description

This PR disable the datasource selector inside query editor. This change is behind feature flag to ensure that if this is needed, we can revert back using feature flag toggling.

EE PR: https://github.com/appsmithorg/appsmith-ee/pull/5382

Fixes #35534

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11512255262
Commit: ccdb522
Cypress dashboard.
Tags: @tag.All
Spec:


Fri, 25 Oct 2024 07:24:38 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Introduced a new feature flag: release_ide_datasource_selector_enabled, allowing for future enhancements to the DatasourceSelector component.
    • Conditional rendering of the DatasourceSelector in the QueryEditorHeader based on the new feature flag.
  • Bug Fixes

    • Disabled the test suite for the "Switch datasource" functionality as it is currently under a feature flag.

These changes enhance the flexibility of the application and improve the user experience by controlling the visibility of features based on their activation status.

@github-actions github-actions bot added IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Task A simple Todo Enhancement New feature or request labels Oct 17, 2024
@albinAppsmith
Copy link
Collaborator Author

/build-deploy-preview skip-test=true

Copy link

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

Copy link
Contributor

coderabbitai bot commented Oct 17, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new feature flag, release_ide_datasource_selector_enabled, to manage the visibility of the DatasourceSelector component within the QueryEditorHeader. This flag is initialized to false in the DEFAULT_FEATURE_FLAG_VALUE object. The rendering logic of the DatasourceSelector is modified to conditionally display the component based on the state of this feature flag, thereby altering the control flow without changing the overall structure of existing constants.

Changes

File Path Change Summary
app/client/src/ce/entities/FeatureFlag.ts Added new feature flag release_ide_datasource_selector_enabled to FEATURE_FLAG and initialized it to false in DEFAULT_FEATURE_FLAG_VALUE.
app/client/src/pages/Editor/QueryEditor/QueryEditorHeader.tsx Introduced a check for the new feature flag to conditionally render the DatasourceSelector component based on its state.
app/client/cypress/e2e/Regression/ServerSide/QueryPane/SwitchDatasource_spec.js Skipped the "Switch datasource" test suite by adding .skip to the describe block, with comments on feature removal.

Possibly related PRs

Suggested labels

skip-changelog, Query & JS Pod, Integrations Product, Test

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007
  • hetunandu

🎉 In the code we weave, a flag we now conceive,
release_ide_datasource_selector_enabled is here,
With logic to show, or hide in the flow,
A toggle for features, let’s give a cheer!
Tests may skip and features flip,
In our codebase, we continue to grip! 🎈


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
app/client/src/pages/Editor/QueryEditor/QueryEditorHeader.tsx (1)

75-77: Approve changes with a minor suggestion for naming clarity.

The introduction of the feature flag is well-implemented. However, consider renaming the constant to isDatasourceSelectorEnabled for better clarity, as the current name might be misleading.

-const isDatasourceSelectorDisabled = useFeatureFlag(
+const isDatasourceSelectorEnabled = useFeatureFlag(
   FEATURE_FLAG.release_ide_datasource_selector_enabled,
 );
app/client/src/ce/entities/FeatureFlag.ts (1)

42-43: LGTM. Consider adding a comment for the new feature flag.

The addition of the release_ide_datasource_selector_enabled flag is consistent with the existing structure and naming conventions. Good job on setting the default value to false, which aligns with the feature flag best practices.

Consider adding a brief comment above the new flag in the FEATURE_FLAG object to describe its purpose. This would improve maintainability and help other developers understand the flag's intended use.

+  // Controls the visibility of the datasource selector in the query editor
   release_ide_datasource_selector_enabled:
     "release_ide_datasource_selector_enabled",

Also applies to: 79-79

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 44a9994 and 7b912ca.

📒 Files selected for processing (2)
  • app/client/src/ce/entities/FeatureFlag.ts (2 hunks)
  • app/client/src/pages/Editor/QueryEditor/QueryEditorHeader.tsx (2 hunks)
🧰 Additional context used

@albinAppsmith albinAppsmith added the ok-to-test Required label for CI label Oct 17, 2024
Copy link

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

@@ -1,5 +1,5 @@
import { dataSources, agHelper } from "../../../../support/Objects/ObjectsCore";
describe(
describe.skip(
Copy link
Contributor

Choose a reason for hiding this comment

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

Any requirement to skip this case? Kindly share details. @albinAppsmith

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@sagar-qa007 we are putting this feature behind feature flag and later remove this. That's why the test is being skipped now and once I remove feature flag I will remove the file itself.

sagar-qa007
sagar-qa007 previously approved these changes Oct 21, 2024
@albinAppsmith
Copy link
Collaborator Author

/build-deploy-preview skip-test=true

Copy link

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

Copy link

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

@albinAppsmith albinAppsmith merged commit 7e1d18d into release Oct 25, 2024
83 checks passed
@albinAppsmith albinAppsmith deleted the action-redesign/remove-datasource-selector branch October 25, 2024 16:22
@coderabbitai coderabbitai bot mentioned this pull request Nov 18, 2024
2 tasks
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Nov 20, 2024
## Description

This PR disable the datasource selector inside query editor. This change
is behind feature flag to ensure that if this is needed, we can revert
back using feature flag toggling.

EE PR: appsmithorg/appsmith-ee#5382


Fixes appsmithorg#35534

## Automation

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

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/11512255262>
> Commit: ccdb522
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11512255262&attempt=3"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Fri, 25 Oct 2024 07:24:38 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced a new feature flag:
`release_ide_datasource_selector_enabled`, allowing for future
enhancements to the `DatasourceSelector` component.
- Conditional rendering of the `DatasourceSelector` in the
`QueryEditorHeader` based on the new feature flag.

- **Bug Fixes**
- Disabled the test suite for the "Switch datasource" functionality as
it is currently under a feature flag.

These changes enhance the flexibility of the application and improve the
user experience by controlling the visibility of features based on their
activation status.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@coderabbitai coderabbitai bot mentioned this pull request Nov 25, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product ok-to-test Required label for CI Task A simple Todo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task] Remove datasource switcher
3 participants