Skip to content

Fix a bunch of dependency-related type issues related to bugs in TypeScript and packages trying to support React 19 #1092

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 9 commits into from
Jan 29, 2025

Conversation

joshunrau
Copy link
Collaborator

@joshunrau joshunrau commented Jan 29, 2025

Fixes the following dependency-related issues:

  • Regression in TypeScript v5.7 causing type errors everywhere
  • Incorrect return type for AnimatePresence in motion/react, which only works with React 19 types. To fix this, we now override both motion and framer-motion, as motion depends on the latest non-breaking version framer-motion, so forcing motion back to the exact version that did not have this problem is not sufficient,
  • [BUG] AnimatePresence cannot be used as a JSX component motiondivision/motion#3027
  • 4th order dependency @mdx-js/react incorrectly specifies React types as peer dependency, with package.json including a forced override to v19, resulting in no error message on installation (normally, pnpm reports conflicting peer dependencies). This is despite there being an open issue to "Support React v19". We can override the override in package.json with pnpm.
  • WebCrypto API is not specified as a global type in @types/node, despite existing. This previously caused no problems, but now does. The libcrypto library now specifies these globally.

Summary by CodeRabbit

Release Notes v1.8.7

  • Dependency Updates

    • Updated project-wide package versions
    • Updated nodemon to version 3.1.9
    • Added motion package version 11.15.0
    • Modified dependency resolution for motion to use catalog references
  • Type Safety Improvements

    • Enhanced type handling for crypto and gateway service imports
    • Refined import statements for better type management
  • Version Bump

    • Incremented project version to 1.8.7

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request encompasses multiple changes across various files in the project. The modifications include type handling improvements in the API development script, type refinements in the gateway service, and dependency version updates across multiple package configurations. The changes primarily focus on enhancing type safety, updating dependency versions, and standardizing package management using catalog references for certain dependencies like motion.

Changes

File Change Summary
apps/api/scripts/dev.ts Updated nodemon import to include specific types and added type casting for better type safety
apps/api/src/gateway/gateway.service.ts Updated type imports and method signature for createRemoteAssignment, specifically changing publicKey type to webcrypto.CryptoKey
apps/playground/package.json Changed motion dependency from version ^11.15.0 to catalog:
apps/web/package.json Changed motion dependency from version ^11.15.0 to catalog:
package.json Updated project version to "1.8.7" and added new PNPM configuration for package overrides
packages/react-core/package.json Changed motion dependency from version ^11.15.0 to catalog:
pnpm-workspace.yaml Updated dependency versions for @douglasneuroinformatics/libcrypto, nodemon, and added motion

Poem

🐰 Hop, skip, and a type-safe jump,
Dependencies dancing with a catalog's thump!
Versions aligned, imports refined,
Our code now leaps, perfectly designed!
Rabbit's code magic, clean and bright! 🚀


📜 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 bb03156 and c3cfa51.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (7)
  • apps/api/scripts/dev.ts (1 hunks)
  • apps/api/src/gateway/gateway.service.ts (3 hunks)
  • apps/playground/package.json (1 hunks)
  • apps/web/package.json (1 hunks)
  • package.json (2 hunks)
  • packages/react-core/package.json (1 hunks)
  • pnpm-workspace.yaml (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 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 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 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. (Beta)
  • @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.

@joshunrau joshunrau merged commit da5b99c into DouglasNeuroInformatics:main Jan 29, 2025
1 check was pending
@joshunrau joshunrau deleted the dependency-hell branch January 30, 2025 16:27
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.

1 participant