Skip to content

fix: Theme update button staying highlighted when switching back to selected one #22616

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

kartik-212004
Copy link
Contributor

What does this PR do?

This PR fixes a form state management issue in the appearance settings where the update button highlight would persist incorrectly when switching back to the original theme selection, particularly when the system theme is selected.

Changes:

  • Normalized theme form default values to handle null/system conversion properly
  • Added useEffect hooks to reset form state when user data changes
  • Ensures consistent dirty state tracking across all theme modes (system, light, dark)
  • Fixed update button highlight persistence issue in system theme mode

Root Cause:
The issue occurred because when "system" theme is selected, it gets stored as null in the database but the form expects the string "system". This mismatch caused incorrect dirty state calculations, leading to the update button staying highlighted when it shouldn't.

Visual Demo

Video Demo:

Before:

Screencast.from.2025-07-18.12-11-03.mp4

After:

Screencast.from.2025-07-18.12-13-16.mp4

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
  • I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

Test Steps:

  1. Navigate to Settings → Appearance tab
  2. Ensure your current theme is set to "System default"
  3. Switch to "Light" or "Dark" theme - observe the update button becomes highlighted
  4. Switch back to "System" theme, you will notice the update button is still highlighted
  5. Repeat the same test flow starting from "Light" theme and switching to "Dark" then back to "Light" and vice versa

Expected Result:

  • Update button should only be highlighted when the selected theme differs from the current saved theme
  • When switching back to the original theme, the button should immediately disable

Test Environment:

  • No specific environment variables needed
  • Test with any user account
  • Verify behavior in both desktop and mobile viewports
  • Test across different browsers to ensure consistency

Test Data:

  • Any user can do it
  • No special test data required

Checklist

  • I have read the contributing guide
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have checked if my changes generate no

Copy link

vercel bot commented Jul 18, 2025

@kartik-212004 is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

coderabbitai bot commented Jul 18, 2025

Walkthrough

The update modifies the AppearanceView component in the settings module by introducing useEffect hooks. These hooks reset the form states for userAppThemeFormMethods and userThemeFormMethods whenever the respective user.appTheme or user.theme values change. The default values for these forms are also set to use "system" if the user-specific values are null or undefined. Additionally, the React useEffect import is added to support this functionality. No changes are made to exported or public entity declarations.

Estimated code review effort

1 (~5 minutes)

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/web/modules/settings/my-account/appearance-view.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-playwright".

(The package "eslint-plugin-playwright" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-playwright@latest --save-dev

The plugin "eslint-plugin-playwright" was referenced from the config file in ".eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e969df4 and ca572eb.

📒 Files selected for processing (1)
  • apps/web/modules/settings/my-account/appearance-view.tsx (7 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/web/modules/settings/my-account/appearance-view.tsx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Install dependencies / Yarn install & cache
  • GitHub Check: Security Check
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@graphite-app graphite-app bot added the community Created by Linear-GitHub Sync label Jul 18, 2025
@graphite-app graphite-app bot requested a review from a team July 18, 2025 07:00
Copy link
Contributor

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

Unknown release type "Fix" found in pull request title "Fix: Theme update button staying highlighted when switching back to selected one". 

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

@kartik-212004 kartik-212004 changed the title Fix: Theme update button staying highlighted when switching back to selected one fix: Theme update button staying highlighted when switching back to selected one Jul 18, 2025
@dosubot dosubot bot added ui area: UI, frontend, button, form, input 🐛 bug Something isn't working labels Jul 18, 2025
Copy link

graphite-app bot commented Jul 18, 2025

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (07/18/25)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add community label" took an action on this PR • (07/18/25)

1 label was added to this PR based on Keith Williams's automation.

@kartik-212004
Copy link
Contributor Author

@kart1ka sir, the PR is ready for review.
Please have a look when you get time.

@kartik-212004
Copy link
Contributor Author

@anikdhabal requires review

@kart1ka
Copy link
Contributor

kart1ka commented Jul 22, 2025

@kartik-212004 I do not see any difference between the before and after video. There also seems to be a type check failing. can you address that as well?

@kartik-212004
Copy link
Contributor Author

@kartik-212004 I do not see any difference between the before and after video. There also seems to be a type check failing. can you address that as well?

I think maybe it's not clearly visible in the before and after video, but here's how you can reproduce it -
If the dashboard theme is initially set to system default, and you select Dark or Light (without clicking update), then switch back to system default, the Update button becomes active, even though the final selection matches the original setting.

and I will check why the type check are failing

@kart1ka kart1ka added the Low priority Created by Linear-GitHub Sync label Jul 23, 2025
Copy link
Contributor

github-actions bot commented Aug 7, 2025

This PR is being marked as stale due to inactivity.

@github-actions github-actions bot added the Stale label Aug 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working community Created by Linear-GitHub Sync Low priority Created by Linear-GitHub Sync Stale ui area: UI, frontend, button, form, input
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants