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: Change the default value of isLoading in settings reducer to true #34490

Merged
merged 6 commits into from
Jul 1, 2024

Conversation

dvj1988
Copy link
Contributor

@dvj1988 dvj1988 commented Jun 26, 2024

Description

This PR makes sure that the initial value of isLoading in the settings reducer is set to true.
This flag is used to conditionally render the loading component and the AdminSettings component in app/client/src/pages/AdminSettings/index.tsx. This change makes sure that the Admin Page components are not mounted and unmounted on initial render. The mouting and unmounting used to happen earlier because the flag switched from false => true => false.

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/9737924972
Commit: 553b867
Cypress dashboard.
Tags: @tag.Sanity

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • Bug Fixes
    • Improved initial loading state of settings to enhance user experience during app startup.

Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Walkthrough

This update modifies the initial state of the settings reducer within a client-side application. Specifically, the isLoading property of the SettingsReduxState has been initialized to true instead of false, likely indicating an initial state where the settings data is being loaded.

Changes

File Path Change Summary
.../src/ce/reducers/settingsReducer.ts isLoading in initialState changed from false to true

Poem

In the land of code, where changes tread,
The setting’s state now starts well-read,
From false to true, it hugs the load,
A tiny tweak, to streamline the road.
🌟 The settings wait, for data's cheer,
While rabbits code, without a fear. 🐇


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.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Jun 26, 2024
@dvj1988 dvj1988 changed the title chore: Fire the current tenant api for admin pages chore: Change the default value of isLoading in settings reducer to true Jun 26, 2024
@dvj1988 dvj1988 marked this pull request as ready for review June 26, 2024 11:35
@dvj1988
Copy link
Contributor Author

dvj1988 commented Jun 26, 2024

/build-deploy-preview skip-tests=true

@dvj1988 dvj1988 self-assigned this Jun 26, 2024
@dvj1988 dvj1988 added the ok-to-test Required label for CI label Jun 26, 2024
Copy link

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

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/ce/reducers/settingsReducer.ts (2)

Line range hint 52-52: Replace hasOwnProperty with Object.hasOwn().

Using Object.hasOwn() is recommended over hasOwnProperty for better safety and standard compliance.

- if (action.payload?.tenantConfiguration?.hasOwnProperty(key)) {
+ if (Object.hasOwn(action.payload?.tenantConfiguration, key)) {

Line range hint 71-71: Replace hasOwnProperty with Object.hasOwn().

As previously noted, Object.hasOwn() is safer and more compliant than hasOwnProperty.

- if (action.payload?.tenantConfiguration?.hasOwnProperty(key)) {
+ if (Object.hasOwn(action.payload?.tenantConfiguration, key)) {
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f8f5ebb and 553b867.

Files selected for processing (1)
  • app/client/src/ce/reducers/settingsReducer.ts (1 hunks)
Additional context used
Biome
app/client/src/ce/reducers/settingsReducer.ts

[error] 52-52: Do not access Object.prototype method 'hasOwnProperty' from target object. (lint/suspicious/noPrototypeBuiltins)

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.


[error] 71-71: Do not access Object.prototype method 'hasOwnProperty' from target object. (lint/suspicious/noPrototypeBuiltins)

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

Additional comments not posted (1)
app/client/src/ce/reducers/settingsReducer.ts (1)

11-11: Change of default value for isLoading approved.

The change to set isLoading to true by default is straightforward. However, ensure that this does not lead to a confusing user experience by showing loading indicators where they aren't necessary.

Copy link

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

@dvj1988 dvj1988 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jul 1, 2024
@dvj1988 dvj1988 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jul 1, 2024
@dvj1988 dvj1988 merged commit f25cae0 into release Jul 1, 2024
61 of 63 checks passed
@dvj1988 dvj1988 deleted the chore/remove-subdetails-consolidated-api branch July 1, 2024 07:27
Shivam-z pushed a commit to Shivam-z/appsmith that referenced this pull request Jul 10, 2024
…rue (appsmithorg#34490)

## Description
This PR makes sure that the initial value of `isLoading` in the settings
reducer is set to true.
This flag is used to conditionally render the loading component and the
AdminSettings component in
`app/client/src/pages/AdminSettings/index.tsx`. This change makes sure
that the Admin Page components are not mounted and unmounted on initial
render. The mouting and unmounting used to happen earlier because the
flag switched from false => true => false.

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/9737924972>
> Commit: 553b867
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9737924972&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity`

<!-- 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

- **Bug Fixes**
- Improved initial loading state of settings to enhance user experience
during app startup.

<!-- 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
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