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

chore: Removed immur dependancy #39324

Merged
merged 1 commit into from
Feb 18, 2025
Merged

chore: Removed immur dependancy #39324

merged 1 commit into from
Feb 18, 2025

Conversation

sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Feb 18, 2025

Description

Fixing this error : https://github.com/appsmithorg/appsmith-ee/pull/6115/files
Removed dependencies.

Fixes # https://app.zenhub.com/workspaces/qa-63316faf86bb2e170ed2e46b/issues/gh/appsmithorg/appsmith/39318

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/13383377889
Commit: 55e9bb0
Cypress dashboard.
Tags: @tag.All
Spec:


Tue, 18 Feb 2025 05:52:11 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • Refactor
    • Updated the app’s internal data handling to ensure more consistent and reliable feature management.
    • Enhanced robustness through improved error management, leading to smoother operation and better control over feature updates.

Copy link
Contributor

coderabbitai bot commented Feb 18, 2025

Walkthrough

The changes remove the usage of the immer library’s produce function in favor of manually creating deep copies using JSON.parse(JSON.stringify(...)). Both the getConsolidatedDataApi and featureFlagInterceptForLicenseFlags functions now use this approach, with added try-catch error handling during JSON parsing. The modifications update the response data directly, including iterating over feature flags and adding a specific flag where necessary. No modifications to public or exported entities have been performed.

Changes

File(s) Change Summary
app/client/cypress/support/Objects/FeatureFlags.ts Replaced immer's produce usage with a manual deep copy via JSON methods. Introduced a try-catch block for error handling during JSON parsing.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant G as getConsolidatedDataApi
    participant J as JSON Parsing

    C->>G: Request consolidated API data
    G->>J: Deep copy original response (JSON.parse(JSON.stringify(...)))
    alt Deep copy successful
        J-->>G: Return deep copied data
        G->>G: Update data.featureFlags.data
        G->>C: Return updated response
    else Error during JSON parsing
        J-->>G: Throw error
        G->>G: Log error in catch block
        G->>C: Return error-handled response
    end
Loading
sequenceDiagram
    participant C as Client
    participant F as featureFlagIntercept
    participant J as JSON Parsing

    C->>F: Provide original feature flags data
    F->>J: Deep copy original response (JSON.parse(JSON.stringify(...)))
    J-->>F: Return deep copied data
    F->>F: Iterate and filter feature flags based on LICENSE_FEATURE_FLAGS
    F->>F: Add 'release_app_sidebar_enabled' flag
    F->>C: Return modified feature flags data
Loading

Suggested labels

Bug, ok-to-test

Suggested reviewers

  • ApekshaBhosale
  • NandanAnantharamu
  • sharat87

Poem

In the world of code so bright,
A JSON dance replaces old might.
Deep copies form with graceful art,
Errors caught before they start.
Flags now shine with a brand new light!
🚀 Happy coding through day and night!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@sagar-qa007 sagar-qa007 changed the title chore: Update chore: Removed immur dependancy Feb 18, 2025
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Feb 18, 2025
@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Feb 18, 2025
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: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 07187a7 and 55e9bb0.

📒 Files selected for processing (1)
  • app/client/cypress/support/Objects/FeatureFlags.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`app/client/cypress/**/**.*`: Review the following e2e test ...

app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
  • app/client/cypress/support/Objects/FeatureFlags.ts
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-prettier / prettier-check
  • GitHub Check: client-build / client-build

Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu left a comment

Choose a reason for hiding this comment

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

Lgtm

@sagar-qa007 sagar-qa007 merged commit f30ef2e into release Feb 18, 2025
91 checks passed
@sagar-qa007 sagar-qa007 deleted the chore/removeimmurdep branch February 18, 2025 06:28
@coderabbitai coderabbitai bot mentioned this pull request Feb 21, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants