Skip to content

chore(deps): Update MUI packages to latest versions (resolves #283). #285

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 2 commits into from
May 23, 2025

Conversation

junhaoliao
Copy link
Member

@junhaoliao junhaoliao commented May 17, 2025

resolves #283

Description

  1. Update "@mui/icons-material" to "^7.1.0", which depends on `"@babel/runtime": "^7.27.1"
  2. Update "@mui/joy" to "^5.0.0-beta.52".

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  1. Performed manual testing with the demo file as instructed by https://docs.yscope.com/yscope-log-viewer/main/dev-guide/contributing-validation.html#manual-testing

Summary by CodeRabbit

  • Chores
    • Updated dependencies to newer versions for improved stability and compatibility.

@junhaoliao junhaoliao requested a review from a team as a code owner May 17, 2025 17:42
Copy link

coderabbitai bot commented May 17, 2025

Walkthrough

The pull request updates the versions of two dependencies in the package.json file: @mui/icons-material is upgraded from ^6.4.1 to ^7.1.0, and @mui/joy is upgraded from ^5.0.0-beta.51 to ^5.0.0-beta.52. No other changes are made.

Changes

File(s) Change Summary
package.json Updated @mui/icons-material and @mui/joy dependency versions.

Assessment against linked issues

Objective Addressed Explanation
Upgrade @babel/runtime to 7.27.1 and related objectives (#283) No changes to @babel/runtime or related objectives are present in this PR.

Possibly related PRs


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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.

Copy link

@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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3cb54e0 and 613e3e6.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • package.json (1 hunks)

Comment on lines +32 to +33
"@mui/icons-material": "^7.1.0",
"@mui/joy": "^5.0.0-beta.52",
Copy link

@coderabbitai coderabbitai bot May 17, 2025

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Verify MUI dependency bump for compatibility and peer dependencies

You’ve upgraded @mui/icons-material to ^7.1.0 (which now depends on @babel/runtime@^7.27.1) and @mui/joy to ^5.0.0-beta.52. Before merging, please ensure:

  • All existing icon and Joy component imports still resolve and behave as expected (review any changed export names or paths).
  • The required peer dependency @babel/runtime is present at the correct version.
  • You’ve checked the MUI v7 migration guide and Joy changelog for any breaking changes or API adjustments.

Run these checks locally:


🏁 Script executed:

#!/bin/bash
# Verify @babel/runtime is installed in the tree
npm ls @babel/runtime

# Inspect icon imports to catch any path/api changes
rg -n "from '@mui/icons-material" -C2

# Inspect Joy imports for potential API shifts
rg -n "from '@mui/joy" -C2

Length of output: 154


Install missing peer dependency and verify MUI v7/Joy imports

npm ls shows no @babel/runtime installed (required by @mui/icons-material@^7.1.0). Please:

--- package.json
@@ dependencies
     "@mui/joy": "^5.0.0-beta.52",
+    "@babel/runtime": "^7.27.1"
  • Run npm install --save @babel/runtime@^7.27.1 (or update your lockfile)
  • Confirm all @mui/icons-material and @mui/joy imports still resolve and behave as expected
  • Review the MUI v7 migration guide and Joy changelog for any breaking changes or API adjustments
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"@mui/icons-material": "^7.1.0",
"@mui/joy": "^5.0.0-beta.52",
"@mui/icons-material": "^7.1.0",
"@mui/joy": "^5.0.0-beta.52",
"@babel/runtime": "^7.27.1"
🤖 Prompt for AI Agents
In package.json around lines 32 to 33, you upgraded @mui/icons-material to
^7.1.0 which requires @babel/runtime@^7.27.1 as a peer dependency, but it is not
installed. Fix this by running npm install --save @babel/runtime@^7.27.1 to add
the missing peer dependency. Then verify that all imports from
@mui/icons-material and @mui/joy still resolve correctly and function as
expected by checking your codebase and running tests. Also review the MUI v7
migration guide and Joy changelog for any breaking changes or API updates to
ensure compatibility.

Copy link
Member Author

Choose a reason for hiding this comment

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

npm automatically installs peer dependencies since v7

Copy link

Choose a reason for hiding this comment

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

@junhaoliao You're absolutely right! My apologies for the oversight. npm v7+ does indeed automatically install peer dependencies, so there's no need to manually add @babel/runtime to your package.json. Thanks for the correction.


✏️ Learnings added
Learnt from: junhaoliao
PR: y-scope/yscope-log-viewer#285
File: package.json:32-33
Timestamp: 2025-05-22T23:03:08.234Z
Learning: npm v7+ automatically installs peer dependencies by default, so there's no need to manually add them to package.json.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.


If you found this review helpful, would you consider giving us a shout-out on X?

Thank you for using CodeRabbit!

@junhaoliao junhaoliao requested a review from kirkrodrigues May 22, 2025 23:03
@@ -30,7 +30,7 @@
"@types/react": "^19.0.7",
"@types/react-dom": "^19.0.3",
"@vitejs/plugin-react-swc": "^3.9.0",
"eslint-config-yscope": "*",
Copy link
Member

Choose a reason for hiding this comment

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

Is this intentional?

Copy link
Member Author

Choose a reason for hiding this comment

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

discussed offline. sharing here for record keeping -

  1. It was previously changed from latest to * by PRs submitted by @dependabot .
  2. However, whenever running npm i locally (on my computer i use [email protected]), the version string is always updated as latest again, which is what we specified in package.json.
  3. latest is an automatic "tag" for the latest release in the npm registry. We did some experiments and found that: if an older version of the dependency was installed, unless both packge-lock.json and node_modules are deleted, npm i does not update the locked version and/or perform upgrade for dependency in node_modules.
  4. We decided to lock "eslint-config-yscope" at specific versions which avoids use of the latest tag in the version strings. Whenever a new eslint-config-yscope is released, we will update the version strings in the referencing repos, which includes:

@coderabbitai create issues in those repos for locking eslint-config-yscope at the latest version with the specific version number.

Copy link

Choose a reason for hiding this comment

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

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Create issue in y-scope/yscope-log-viewer
gh issue create \
  --repo y-scope/yscope-log-viewer \
  --title "Lock eslint-config-yscope dependency to a specific version (not latest or *)" \
  --body "Currently, the 'eslint-config-yscope' dependency is referenced using the 'latest' tag or '*'. Based on recent discussions and experiments (see [PR #285](https://github.com/y-scope/yscope-log-viewer/pull/285), [comment](https://github.com/y-scope/yscope-log-viewer/pull/285#discussion_r2103550852)), we found that using 'latest' or '*' can lead to inconsistent dependency resolution and upgrades. To ensure reproducibility and avoid unexpected upgrades, we should lock 'eslint-config-yscope' at a specific version number. Whenever a new version is released, we will update the version string explicitly in this repository. Requested by @junhaoliao." \
  --assignee junhaoliao

# Create issue in y-scope/clp
gh issue create \
  --repo y-scope/clp \
  --title "Lock eslint-config-yscope dependency to a specific version (not latest or *)" \
  --body "Currently, the 'eslint-config-yscope' dependency is referenced using the 'latest' tag or '*'. Based on recent discussions and experiments (see [yscope-log-viewer PR #285](https://github.com/y-scope/yscope-log-viewer/pull/285), [comment](https://github.com/y-scope/yscope-log-viewer/pull/285#discussion_r2103550852)), we found that using 'latest' or '*' can lead to inconsistent dependency resolution and upgrades. To ensure reproducibility and avoid unexpected upgrades, we should lock 'eslint-config-yscope' at a specific version number. Whenever a new version is released, we will update the version string explicitly in this repository. Requested by @junhaoliao." \
  --assignee junhaoliao

Length of output: 1807


@junhaoliao Issues have been created as requested:

Both track locking eslint-config-yscope to a specific version and updating manually when new releases are available.


✏️ Learnings added
Learnt from: junhaoliao
PR: y-scope/yscope-log-viewer#285
File: package-lock.json:33-33
Timestamp: 2025-05-23T15:19:35.664Z
Learning: For the y-scope/yscope-log-viewer and y-scope/clp repositories, the team has decided to lock the "eslint-config-yscope" dependency at a specific version (not "latest" or "*"). When a new version is released, the version string will be updated explicitly in each referencing repository.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@junhaoliao junhaoliao merged commit fe22a3c into y-scope:main May 23, 2025
3 checks passed
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.

2 participants