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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: added fix for disabling the autocommit feature without feature flag #34015

Merged
merged 1 commit into from
Jun 6, 2024

Conversation

sondermanish
Copy link
Contributor

@sondermanish sondermanish commented Jun 6, 2024

Description

  • Added @featureFlagged annotation (release_git_autocommit_enabled) to the interface method isAutoCommitRequired for AutocommitEligibilityHelper to disable the autocommit as a feature

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.Git"

馃攳 Cypress test results

Tip

馃煝 馃煝 馃煝 All cypress tests have passed! 馃帀 馃帀 馃帀
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9397519853
Commit: 55da1e6
Cypress dashboard url: Click here!

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Introduced feature flagging for the auto-commit functionality to provide more control over its deployment.

@sondermanish sondermanish requested a review from a team as a code owner June 6, 2024 08:18
@sondermanish sondermanish self-assigned this Jun 6, 2024
@github-actions github-actions bot added the Bug Something isn't working label Jun 6, 2024
@sondermanish sondermanish added the ok-to-test Required label for CI label Jun 6, 2024
Copy link
Contributor

coderabbitai bot commented Jun 6, 2024

Walkthrough

The primary change involves adding a new feature flag annotation @FeatureFlagged with the flag release_git_autocommit_feature_enabled to the isAutoCommitRequired method in the AutoCommitEligibilityHelperImpl.java file. This feature flag will control the auto-commit functionality based on specific conditions. Additionally, there are modifications to the method declarations for better integration and functionality.

Changes

File Path Change Summary
app/server/appsmith-server/src/main/java/com/appsmith/server/git/autocommit/helpers/AutoCommitEligibilityHelperImpl.java Added @FeatureFlagged annotation to isAutoCommitRequired method. Modified method declarations for isClientMigrationRequired and isAutoCommitRequired.

Poem

In the land of code, where features bloom,
A flag was raised, to lift the gloom.
Auto-commit now stands on guard,
With checks and balances, ever so hard.
Hail to progress, with every bit,
Our codebase shines, bit by bit!
馃殌馃悋


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.
    • @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 as 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.

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.

@nidhi-nair nidhi-nair merged commit cc83cb5 into release Jun 6, 2024
49 of 51 checks passed
@nidhi-nair nidhi-nair deleted the fix/disable-autocommit branch June 6, 2024 08:43
Copy link

github-actions bot commented Jun 6, 2024

Failed server tests

  • com.appsmith.server.git.CommonGitServiceCETest#getProtectedBranches_WhenUserHasMultipleBranchProtected_ReturnsEmptyOrDefaultBranchOnly
  • com.appsmith.server.git.autocommit.ApplicationPageServiceAutoCommitTest#testAutoCommit_whenAutoCommitNotEligible_returnsFalse
  • com.appsmith.server.git.autocommit.ApplicationPageServiceAutoCommitTest#testAutoCommit_whenOnlyClientIsEligibleForMigration_commitSuccess
  • com.appsmith.server.git.autocommit.ApplicationPageServiceAutoCommitTest#testAutoCommit_whenOnlyServerIsEligibleForMigration_commitSuccess

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 04ce4b8 and 55da1e6.

Files selected for processing (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/git/autocommit/helpers/AutoCommitEligibilityHelperImpl.java (1 hunks)
Additional comments not posted (5)
app/server/appsmith-server/src/main/java/com/appsmith/server/git/autocommit/helpers/AutoCommitEligibilityHelperImpl.java (5)

Line range hint 94-113: The implementation of auto-commit eligibility checks is well-done, combining both server and client requirements effectively.


Line range hint 31-67: The implementation of server auto-commit eligibility looks robust. However, ensure that the locking mechanism is tested thoroughly to avoid potential deadlocks.


Line range hint 31-31: Ensure the feature flag is correctly set in the configuration.


94-94: Ensure the feature flag is correctly set in the configuration.

Verification successful

The feature flag release_git_autocommit_feature_enabled is indeed present in multiple locations within the codebase, including configuration files and test files. This confirms that the feature flag is correctly set and utilized.

  • app/client/src/ce/entities/FeatureFlag.ts: The feature flag is defined here.
  • app/server/appsmith-server/src/main/java/com/appsmith/server/git/autocommit/helpers/AutoCommitEligibilityHelperImpl.java: The feature flag is used here.
  • app/server/appsmith-interfaces/src/main/java/com/appsmith/external/enums/FeatureFlagEnum.java: The feature flag is enumerated here.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the feature flag is set in the configuration files.

# Test: Search for the feature flag in the configuration files. Expect: At least one occurrence.
rg --type yaml 'release_git_autocommit_feature_enabled'

Length of output: 55



Script:

#!/bin/bash
# Description: Verify the feature flag is set in the configuration files.

# Test: Search for the feature flag in Java properties files. Expect: At least one occurrence.
rg --type properties 'release_git_autocommit_feature_enabled'

# Test: Search for the feature flag in environment variable files. Expect: At least one occurrence.
rg --type env 'release_git_autocommit_feature_enabled'

Length of output: 179



Script:

#!/bin/bash
# Description: Verify the feature flag is set in the configuration files.

# Test: Search for the feature flag in all files. Expect: At least one occurrence.
rg 'release_git_autocommit_feature_enabled'

Length of output: 3704


Line range hint 69-69: Ensure the feature flag is correctly set in the configuration.

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.

None yet

2 participants