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: bump internal effect pacakge #1009

Merged
merged 1 commit into from
Oct 14, 2024
Merged

chore: bump internal effect pacakge #1009

merged 1 commit into from
Oct 14, 2024

Conversation

juliusmarminge
Copy link
Collaborator

@juliusmarminge juliusmarminge commented Oct 14, 2024

follow-up on #1005

Summary by CodeRabbit

  • New Features

    • Updated dependencies across multiple packages to enhance performance and compatibility.
  • Bug Fixes

    • Corrected export path for type definitions in the shared package.
  • Refactor

    • Simplified type definitions in the UTApi class to streamline HTTP client interactions.

Copy link

changeset-bot bot commented Oct 14, 2024

⚠️ No Changeset found

Latest commit: 97b69fa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Oct 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-uploadthing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 7:43am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
legacy-docs-uploadthing ⬜️ Ignored (Inspect) Visit Preview Oct 14, 2024 7:43am

@github-actions github-actions bot added the sdk label Oct 14, 2024
Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

Walkthrough

The pull request includes updates to the package.json files across three packages: @example/backend-adapters-server, @uploadthing/shared, and uploadthing. These updates primarily involve incrementing the versions of several dependencies, particularly the effect package and related packages from the @effect namespace. Additionally, there are type simplifications in the UTApi class within the uploadthing package, specifically in the runtime and executeAsync methods.

Changes

File Change Summary
examples/backend-adapters/server/package.json Updated dependencies: @effect/platform from 0.66.2 to 0.68.4, @effect/platform-node from 0.61.3 to 0.63.4, @effect/schema from 0.74.1 to 0.75.4, effect from 3.8.4 to 3.9.2.
packages/shared/package.json Updated version to 7.0.3, effect from 3.8.4 to 3.9.2, corrected export path from ./dist/index.d.cts to ./dist/index.d.ts.
packages/uploadthing/package.json Updated dependencies: @effect/platform from 0.66.2 to 0.68.4, @effect/schema from 0.74.1 to 0.75.4, effect from 3.8.4 to 3.9.2.
packages/uploadthing/src/sdk/index.ts Updated UTApi class: simplified runtime type and executeAsync method parameter type.

Possibly related PRs

  • chore: sync key usage on upload #998: This PR updates the upload.browser.ts and upload.server.ts files to include the version from package.json in upload requests, which is relevant as the main PR also updates the effect package version in package.json.
  • chore: update effect/platform past API changes #1005: This PR updates the effect dependencies in multiple files, including package.json, which aligns with the main PR's updates to the effect package version.

Suggested labels

examples

Suggested reviewers

  • juliusmarminge

Poem

In the garden where code does bloom,
Dependencies dance, dispelling gloom.
With versions updated, we hop with glee,
Simplified types, oh what a spree!
From 0.66 to 0.68, we leap,
In the world of code, our joy runs deep! 🐇✨


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

pkg-pr-new bot commented Oct 14, 2024

Open in Stackblitz

More templates

pnpm add https://pkg.pr.new/pingdotgg/uploadthing/@uploadthing/shared@1009
pnpm add https://pkg.pr.new/pingdotgg/uploadthing@1009

commit: 97b69fa

Copy link
Contributor

📦 Bundle size comparison

Bundle Size (gzip) Visualization
Main 26.11KB See Treemap 📊
PR (130cfaa) 26.11KB See Treemap 📊
Diff ↓4.00B

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

🧹 Outside diff range and nitpick comments (1)
packages/uploadthing/package.json (1)

Line range hint 3-3: Consider bumping the patch version.

The package version remains at 7.1.0 despite several dependency updates. While these updates may not introduce breaking changes, they might add new features or capabilities.

Consider incrementing the patch version (e.g., to 7.1.1) to reflect these updates, especially if they enhance the package's functionality or performance.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d43590c and 97b69fa.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • examples/backend-adapters/server/package.json (1 hunks)
  • packages/shared/package.json (1 hunks)
  • packages/uploadthing/package.json (1 hunks)
  • packages/uploadthing/src/sdk/index.ts (2 hunks)
🧰 Additional context used
🔇 Additional comments (9)
examples/backend-adapters/server/package.json (1)

15-17: LGTM! Dependency versions updated appropriately.

The updates to the @effect ecosystem packages and the effect package are consistent and align with the PR objectives. These are minor version increments, which typically indicate new features or non-breaking changes.

To ensure compatibility and catch any potential issues, please run the following verification steps:

  1. Update the lockfile (if not already done):

  2. Run the existing test suite:

  3. Start the development server for each adapter to check for any startup issues:

If all tests pass and the development servers start without issues, we can be more confident in these updates.

Also applies to: 23-23

packages/shared/package.json (3)

Line range hint 3-3: Version bump looks appropriate.

The package version has been incremented from 7.0.2 to 7.0.3, which is consistent with a minor update. This aligns well with the nature of the changes in this PR.


Line range hint 1-79: Summary of changes and their impact.

This PR updates the @uploadthing/shared package:

  1. The package version has been bumped to 7.0.3.
  2. The 'effect' dependency has been updated from 3.8.4 to 3.9.2.

These changes appear to be routine maintenance. The minor version update of the 'effect' package should be backwards compatible, but it's important to verify that it doesn't introduce any breaking changes or deprecations that affect your codebase.

There's an inconsistency between the AI-generated summary and the actual changes regarding the 'exports' section. This discrepancy should be clarified to ensure all intended changes are properly implemented and documented.


39-39: Dependency 'effect' has been updated.

The 'effect' package has been updated from version 3.8.4 to 3.9.2. This is a minor version update, which should maintain backwards compatibility while potentially introducing new features or bug fixes.

To ensure this update doesn't introduce any breaking changes, please run the following script:

packages/uploadthing/package.json (2)

153-153: Verify changelog for @effect/platform update.

The @effect/platform dependency has been updated from 0.66.2 to 0.68.4. This minor version bump may introduce new features.

Please review the changelog for any breaking changes or deprecations:


154-154: Verify changelog for @effect/schema update.

The @effect/schema dependency has been updated from 0.74.1 to 0.75.4. This minor version bump may introduce new features.

Please review the changelog for any breaking changes or deprecations:

packages/uploadthing/src/sdk/index.ts (3)

50-52: Summary: Type simplifications in UTApi class

The changes in this file involve type simplifications in the UTApi class, specifically in the runtime property and executeAsync method. These modifications appear to be part of a broader update to align with new versions of the @effect/platform and effect packages.

Key points:

  1. The changes are consistent with each other.
  2. No functional changes were observed in the implementation.
  3. The modifications are low-risk, primarily affecting type definitions.

To ensure these changes are part of a coordinated update, please verify the following:

  1. Check if there's a corresponding update in the package.json file for the @effect/platform and effect packages.
  2. Review the changelogs of these packages to confirm that these type changes are expected.
  3. Run the test suite to ensure no regressions have been introduced.
#!/bin/bash
# Check package versions and run tests
npm list @effect/platform effect
npm test

Also applies to: 92-93


92-93: LGTM! Verify effect package update.

The update to the program parameter type in the executeAsync method is consistent with the earlier change to the runtime property. It removes the .Service suffix from HttpClient.HttpClient.Service, which aligns with the apparent changes in the @effect/platform package structure.

Please ensure that this change is consistent with the latest version of the effect package. Run the following command to check the package version and recent changes:

#!/bin/bash
# Check effect package version and recent changes
npm list effect
npm view effect changelog

50-52: LGTM! Verify @effect/platform package update.

The simplification of the runtime property type looks good. It removes the .Service suffix from HttpClient.HttpClient.Service, which suggests an update in the @effect/platform package structure.

Please ensure that this change is consistent with the latest version of the @effect/platform package. Run the following command to check the package version and recent changes:

packages/uploadthing/package.json Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant