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: If navigation settings object is empty in application details, use the default settings #27779

Merged
merged 1 commit into from
Oct 4, 2023

Conversation

dhruvikn
Copy link
Contributor

@dhruvikn dhruvikn commented Oct 3, 2023

Description

We removed the clone/duplication feature, but if an app for some reason has an empty navigation settings object - it doesn't show any pages in the navbar nor any of the customization options for navigation inside the app settings pane. This PR adds a check for this and uses the default navigation settings as a fallback.

PR fixes following issue(s)

Fixes #27721
Fixes #23565

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Testing

How Has This Been Tested?

To recreate this scenario, we can import this app that has an empty navigation settings object. App JSON here.

  • Manual
  • JUnit
  • Jest
  • Cypress

Test Plan

Add Testsmith test cases links that relate to this PR

Issues raised during DP testing

Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR)

Checklist:

Dev activity

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • PR is being merged under a feature flag

QA activity:

  • Speedbreak features have been covered
  • Test plan covers all impacted features and areas of interest
  • Test plan has been peer reviewed by project stakeholders and other QA members
  • Manually tested functionality on DP
  • We had an implementation alignment call with stakeholders post QA Round 2
  • Cypress test cases have been added and approved by SDET/manual QA
  • Added Test Plan Approved label after Cypress tests were reviewed
  • Added Test Plan Approved label after JUnit tests were reviewed

Summary by CodeRabbit

  • New Features

    • Enhanced logic for determining application navigation settings, ensuring that the default setting is assigned only when the navigation setting is absent or explicitly empty.
  • Bug Fixes

    • Improved state management by refining the handling of empty navigation settings, preventing potential issues with application navigation initialization.

@dhruvikn dhruvikn self-assigned this Oct 3, 2023
@github-actions github-actions bot added App Navigation Issues related to the topbar navigation and configuring it App setting Related to app settings panel within the app Widgets Product This label groups issues related to widgets Bug Something isn't working High This issue blocks a user from building or impacts a lot of users Needs Triaging Needs attention from maintainers to triage IDE Pod Issues that new developers face while exploring the IDE Production labels Oct 3, 2023
@dhruvikn dhruvikn changed the title fix: if navigation settings are empty in application details, use the default settings fix: If navigation settings object is empty in application details, use the default settings Oct 3, 2023
@dhruvikn
Copy link
Contributor Author

dhruvikn commented Oct 3, 2023

/ok-to-test

@github-actions
Copy link

github-actions bot commented Oct 3, 2023

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/6392122554.
Workflow: Appsmith External Integration Test Workflow.
Commit: ``.
PR: 27779.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=27779&runId=6392122554_1

@dhruvikn
Copy link
Contributor Author

dhruvikn commented Oct 3, 2023

/build-deploy-preview skip-tests=true

@github-actions
Copy link

github-actions bot commented Oct 3, 2023

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

@github-actions
Copy link

github-actions bot commented Oct 3, 2023

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

@github-actions
Copy link

github-actions bot commented Oct 3, 2023

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/6392122554.
Commit: ``.
Cypress dashboard url: Click here!
All cypress tests have passed 🎉🎉🎉

@laveena-en
Copy link
Contributor

Tested the fix, changes look good to me.

@laveena-en laveena-en added the Test Plan Approved Manual/Cypress tests covers changes made on the PR. Else, add skip-testPlan label if not applicable label Oct 4, 2023
@Aishwarya-U-R Aishwarya-U-R merged commit 14e75be into release Oct 4, 2023
26 of 27 checks passed
@Aishwarya-U-R Aishwarya-U-R deleted the fix/navigation-settings-empty branch October 4, 2023 09:18
@Nikhil-Nandagopal Nikhil-Nandagopal added the IDE Product Issues related to the IDE Product label Aug 5, 2024
@github-actions github-actions bot added the QA Needs QA attention label Aug 5, 2024
Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

Warning

Rate limit exceeded

@Nikhil-Nandagopal has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 16 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 43940b7 and 68c8824.

Walkthrough

The recent updates to the applicationsReducer.tsx enhance the state management logic regarding navigationSetting. By adding checks to determine when navigationSetting is either falsy or an empty object, the changes aim to improve the persistence and integrity of the application’s navigation settings, particularly addressing issues with the navbar toggle functionality.

Changes

File Path Change Summary
app/client/src/ce/reducers/uiReducers/applicationsReducer.tsx Expanded logic for assigning defaultNavigationSetting to include checks for empty objects using isEmpty from lodash.

Assessment against linked issues

Objective Addressed Explanation
Ensure navbar toggle state persists across navigation pane (related to #27721)
Fix navbar settings in cloned apps after toggling in the primary app (related to #23565)

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 Configuration 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.

@Nikhil-Nandagopal Nikhil-Nandagopal added Artifact Platform Product Issues related to the application platform and removed IDE Pod Issues that new developers face while exploring the IDE Artifact Platform Product Issues related to the application platform labels Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
App Navigation Issues related to the topbar navigation and configuring it App setting Related to app settings panel within the app Bug Something isn't working High This issue blocks a user from building or impacts a lot of users IDE Product Issues related to the IDE Product Needs Triaging Needs attention from maintainers to triage Production QA Needs QA attention Test Plan Approved Manual/Cypress tests covers changes made on the PR. Else, add skip-testPlan label if not applicable Widgets Product This label groups issues related to widgets
Projects
None yet
5 participants