Skip to content

fix: handles premium integrations based on release and license flags#39982

Merged
sneha122 merged 3 commits intoreleasefrom
feat/external-saas-feature-flag-control
Apr 2, 2025
Merged

fix: handles premium integrations based on release and license flags#39982
sneha122 merged 3 commits intoreleasefrom
feat/external-saas-feature-flag-control

Conversation

@sneha122
Copy link
Contributor

@sneha122 sneha122 commented Mar 31, 2025

Description

This Pr ensures that both release_external_saas_plugins_enabled and license_external_saas_plugins_enabled flags are being used for the frontend code as well where we show upcoming sections and premium tags

Fixes #39738
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.Datasource"

🔍 Cypress test results

Tip

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


Tue, 01 Apr 2025 09:53:12 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Introduced a configurable flag that manages premium integration options for external SaaS plugins, set to off by default.
    • Added checks for premium integrations based on the new feature flag in relevant components.
  • Refactor

    • Streamlined naming and logic for integration controls to enhance clarity in displaying premium plugins and data sources.
    • Improved error handling when accessing plugin icons to prevent runtime errors.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 31, 2025

Walkthrough

This pull request introduces the license_external_saas_plugins_enabled feature flag and integrates it across various components. The flag is added to the feature flag constants with a default value of false. In multiple integration components, the property isGACEnabled is renamed to isIntegrationsEnabledForPaid, updating conditional logic for rendering and filtering premium integrations.

Changes

File(s) Change Summary
app/.../FeatureFlag.ts Added a new feature flag license_external_saas_plugins_enabled with default value false in both the constant and default value objects.
app/.../IntegrationEditor/APIOrSaasPlugins.tsx, app/.../IntegrationEditor/PremiumDatasources/index.tsx Renamed property from isGACEnabled to isIntegrationsEnabledForPaid and updated related conditional logic and state mapping.
app/.../IntegrationEditor/EmptySearchedPlugins.tsx Introduced a new variable isIntegrationsEnabledForPaid via useSelector to extend logic for premium integrations filtering.
app/.../DataSidePane/DataSidePane.tsx Updated access to iconLocation property using optional chaining to enhance robustness.
app/.../selectors/entitiesSelector.ts Added a new conditional check in getDatasourcesGroupedByPluginCategory to default non-existent plugins to PluginCategory.SAAS.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant E as EmptySearchedPlugins
    participant S as useSelector
    participant F as Feature Flag
    U->>E: Render Component
    E->>S: Query "license_external_saas_plugins_enabled" status
    S-->>E: Return flag status (false)
    E->>E: Evaluate (isExternalSaasEnabled OR isIntegrationsEnabledForPaid)
    E->>Premium: Filter premium integrations based on flag
Loading

Assessment against linked issues

Objective Addressed Explanation
Plan for handling integrations during business plan downgrade [#39738]

Possibly related PRs

Suggested labels

Query & JS Pod, Integrations Product, Integrations Pod General, Widgets & Accelerators Pod

Suggested reviewers

  • AmanAgarwal041

Poem

A fresh flag takes flight in our code so bright,
Guiding integrations with newfound light.
Renamed props streamline our logic’s art,
Premium paths now play their part.
Cheers to clarity and clean code delight!


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 4b8b87c and e35e943.

📒 Files selected for processing (3)
  • app/client/src/ce/entities/FeatureFlag.ts (2 hunks)
  • app/client/src/ce/selectors/entitiesSelector.ts (1 hunks)
  • app/client/src/pages/Editor/DataSidePane/DataSidePane.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/client/src/ce/entities/FeatureFlag.ts
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
  • GitHub Check: client-build / client-build
🔇 Additional comments (2)
app/client/src/pages/Editor/DataSidePane/DataSidePane.tsx (1)

127-127: Good defensive programming improvement

Adding optional chaining (?.) and a fallback value prevents potential runtime errors if groupedPlugins[data.pluginId] is undefined. This is a good safety improvement that aligns with the PR's goal of handling premium integrations that might be conditionally available based on license flags.

app/client/src/ce/selectors/entitiesSelector.ts (1)

127-129: Defensive programming added to handle missing plugins.

The added code ensures datasources with non-existent plugins are categorized as SAAS instead of potentially causing errors. This is a good defensive programming practice.


🪧 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 plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions github-actions bot added Query Widgets & IDE Pod All issues related to Query, JS, Eval, Widgets & IDE Task A simple Todo Unplanned Work - Q&W Work items that are unplanned Bug Something isn't working labels Mar 31, 2025
@sneha122 sneha122 added the ok-to-test Required label for CI label Mar 31, 2025
@sneha122
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

@github-actions
Copy link

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

@github-actions
Copy link

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

AmanAgarwal041
AmanAgarwal041 previously approved these changes Mar 31, 2025
@sneha122
Copy link
Contributor Author

sneha122 commented Apr 1, 2025

/build-deploy-preview skip-tests=true

@github-actions
Copy link

github-actions bot commented Apr 1, 2025

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

@github-actions
Copy link

github-actions bot commented Apr 1, 2025

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

@sneha122 sneha122 merged commit a475973 into release Apr 2, 2025
45 checks passed
@sneha122 sneha122 deleted the feat/external-saas-feature-flag-control branch April 2, 2025 06:18
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Apr 12, 2025
…ppsmithorg#39982)

## Description
This Pr ensures that both release_external_saas_plugins_enabled and
license_external_saas_plugins_enabled flags are being used for the
frontend code as well where we show upcoming sections and premium tags


Fixes appsmithorg#39738   
_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.Datasource"

### 🔍 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/14191640435>
> Commit: e35e943
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=14191640435&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Datasource`
> Spec:
> <hr>Tue, 01 Apr 2025 09:53:12 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 configurable flag that manages premium integration
options for external SaaS plugins, set to off by default.
- Added checks for premium integrations based on the new feature flag in
relevant components.

- **Refactor**
- Streamlined naming and logic for integration controls to enhance
clarity in displaying premium plugins and data sources.
- Improved error handling when accessing plugin icons to prevent runtime
errors.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: “sneha122” <“sneha@appsmith.com”>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working ok-to-test Required label for CI Query Widgets & IDE Pod All issues related to Query, JS, Eval, Widgets & IDE Task A simple Todo Unplanned Work - Q&W Work items that are unplanned

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Plan for the integrations usage if the business downgrade their plan (What will happen in such case?)

2 participants