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: use feature flags when hide form control #37143

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

znamenskii-ilia
Copy link
Contributor

@znamenskii-ilia znamenskii-ilia commented Oct 30, 2024

Description

Fixes #Issue Number
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.Sanity"

🔍 Cypress test results

Tip

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


Wed, 30 Oct 2024 16:28:12 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced visibility logic in the FormControl component based on feature flags.
    • Improved configurability of the component's rendering based on application state.
  • Bug Fixes

    • Updated memoization logic to prevent unnecessary re-renders when props remain unchanged.
  • Refactor

    • Adjusted internal state management to incorporate feature flags for better performance and responsiveness.

Copy link
Contributor

coderabbitai bot commented Oct 30, 2024

Walkthrough

The changes in this pull request focus on the FormControl component within FormControl.tsx. Key modifications include the addition of a new import for selectFeatureFlags, which is used to retrieve feature flags from the Redux store. The visibility logic is adjusted to incorporate these flags, impacting the rendering behavior of the component. Additionally, the memoization process is refined to optimize performance by ensuring that unnecessary re-renders are avoided based on prop changes.

Changes

File Change Summary
app/client/src/pages/Editor/FormControl.tsx - Added import for selectFeatureFlags.
- Updated isHidden function to include featureFlags.
- Adjusted internal state management to incorporate featureFlags.
- Enhanced memoization for the disabled prop.

Possibly related PRs

Suggested labels

Enhancement, IDE Product, Task, ok-to-test

Suggested reviewers

  • nidhi-nair
  • ApekshaBhosale

🎉 In the land of code where features bloom,
Flags flutter gently, dispelling the gloom.
A component reworked, now smart and spry,
With props that remember, it reaches for the sky!
So let’s celebrate this change with cheer,
For the FormControl shines bright and clear! 🌟


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.

@znamenskii-ilia znamenskii-ilia added the ok-to-test Required label for CI label Oct 30, 2024
@github-actions github-actions bot added the Bug Something isn't working label Oct 30, 2024
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: 0

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

65-69: Consider adding null check for feature flags.

While the implementation is correct, consider adding a null check for the featureFlags object to prevent potential runtime errors.

  const hidden = isHidden(
    formValueForEvaluatingHiddenObj,
    props.config.hidden,
-   featureFlags,
+   featureFlags ?? {},
  );

Line range hint 214-219: Enhance memo comparison for better performance.

The current memo comparison might miss important prop changes. Consider implementing a more thorough comparison of relevant props.

 export default memo(FormControl, (prevProps, nextProps) => {
   return (
-    prevProps === nextProps &&
-    prevProps.config.disabled === nextProps.config.disabled
+    prevProps.formName === nextProps.formName &&
+    prevProps.config.disabled === nextProps.config.disabled &&
+    prevProps.config.configProperty === nextProps.config.configProperty &&
+    shallowEqual(prevProps.config.hidden, nextProps.config.hidden)
   );
 });
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5458e89 and 7f833e9.

📒 Files selected for processing (1)
  • app/client/src/pages/Editor/FormControl.tsx (3 hunks)
🔇 Additional comments (1)
app/client/src/pages/Editor/FormControl.tsx (1)

34-34: LGTM: Clean feature flags integration.

The feature flags setup follows Redux best practices with proper selector usage.

Also applies to: 52-52

@znamenskii-ilia znamenskii-ilia merged commit ff70e3a into release Oct 30, 2024
49 checks passed
@znamenskii-ilia znamenskii-ilia deleted the fix/pass-feature-flag branch October 30, 2024 16:29
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Nov 20, 2024
## Description


Fixes #`Issue Number`  
_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.Sanity"

### 🔍 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/11596803399>
> Commit: 7f833e9
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11596803399&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity`
> Spec:
> <hr>Wed, 30 Oct 2024 16:28:12 UTC
<!-- end of auto-generated comment: Cypress test results  -->


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


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

## Summary by CodeRabbit

- **New Features**
- Enhanced visibility logic in the FormControl component based on
feature flags.
- Improved configurability of the component's rendering based on
application state.

- **Bug Fixes**
- Updated memoization logic to prevent unnecessary re-renders when props
remain unchanged.

- **Refactor**
- Adjusted internal state management to incorporate feature flags for
better performance and responsiveness.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants