Skip to content

Replace Redux with Zustand for state management #163

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

Merged
merged 21 commits into from
Jul 7, 2025
Merged

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 6, 2025

This PR completes the migration from Redux to Zustand for state management in the CityEnergyAnalyst-GUI application, significantly simplifying the codebase and reducing boilerplate.

What Changed

✅ Core Migration Complete

  • Main application now runs entirely on Zustand - replaced Redux for tools, jobs, navigation, and routing
  • Created 4 new Zustand stores:
    • toolsStore.js - handles tool list, parameters, and saving state
    • jobsStore.js - manages job creation, updates, and deletion
    • navigationStore.js - replaces connected-react-router for routing
    • databaseEditorStore.js - Zustand equivalent (not yet used)

🔧 Component Migrations

Migrated 15+ components from Redux to Zustand:

  • Tools: Tool.jsx
  • Jobs: JobInfoList.jsx, JobInfoCard.jsx
  • Project: ScenarioRow.jsx, Toolbar.jsx, BottomToolButtons.jsx
  • Core: App.jsx, HomePage.jsx, main.jsx, StatusBar.jsx
  • Utils: hooks.jsx, ValidationErrors.jsx

🗑️ Cleanup & Dependencies

  • Removed major Redux dependencies: connected-react-router, redux-logger
  • Deleted unused files: old store configs, actions, reducers (8 files removed)
  • Kept minimal Redux: Only for 6 DatabaseEditor components (isolated setup)

Before vs After

Before: Complex Redux setup with actions, reducers, middleware, and connected-react-router

// Redux pattern - lots of boilerplate
const mapStateToProps = (state) => ({ tools: state.toolList.tools });
const mapDispatchToProps = (dispatch) => ({ fetchTools: () => dispatch(fetchToolList()) });

After: Simple Zustand stores with direct state access

// Zustand pattern - clean and simple
const { tools, fetchToolList } = useToolsStore();
useEffect(() => { fetchToolList(); }, []);

Architecture

  • Main App: 100% Zustand (tools, jobs, navigation, projects, users, maps, etc.)
  • DatabaseEditor: Isolated minimal Redux store (6 components)
  • Clean separation: No conflicts between the two state management systems

Benefits

  • Less boilerplate - eliminated actions/reducers pattern
  • Smaller bundle size - removed unnecessary Redux dependencies
  • Simpler debugging - direct state access instead of time-travel debugging
  • Better TypeScript support - Zustand has excellent TS integration
  • Async built-in - no need for redux-thunk or similar middleware
  • Modern React patterns - hooks-based API

Testing

  • ✅ All builds pass successfully
  • ✅ No breaking changes to existing functionality
  • ✅ Core features (tools, jobs, navigation) working correctly
  • ✅ DatabaseEditor still functional with isolated Redux

Fixes #162.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Copilot Copilot AI changed the title [WIP] Replace Redux with Zustand Replace Redux with Zustand for state management Jul 6, 2025
@Copilot Copilot AI requested a review from reyery July 6, 2025 12:40
Copilot finished work on behalf of reyery July 6, 2025 12:40
Copy link
Contributor

coderabbitai bot commented Jul 7, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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? Join our Discord community 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 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.

@reyery reyery marked this pull request as ready for review July 7, 2025 00:13
@reyery reyery merged commit 2be1219 into master Jul 7, 2025
1 check passed
@reyery reyery deleted the copilot/fix-162 branch July 7, 2025 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace Redux with Zustand
2 participants