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 effect #1030

Merged
merged 3 commits into from
Oct 25, 2024
Merged

chore: bump effect #1030

merged 3 commits into from
Oct 25, 2024

Conversation

juliusmarminge
Copy link
Collaborator

@juliusmarminge juliusmarminge commented Oct 25, 2024

Closes #1027

Summary by CodeRabbit

  • New Features

    • Updated various package dependencies to enhance performance and stability.
  • Bug Fixes

    • Incremented versions of key dependencies, potentially addressing minor issues and improving functionality.
  • Improvements

    • Enhanced error handling and type-checking mechanisms for better robustness.
    • Streamlined utility functions for improved performance and clarity in handling data.

Copy link

changeset-bot bot commented Oct 25, 2024

⚠️ No Changeset found

Latest commit: effdbe0

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 25, 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 25, 2024 9:24am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
legacy-docs-uploadthing ⬜️ Ignored (Inspect) Visit Preview Oct 25, 2024 9:24am

Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

Walkthrough

The pull request includes updates to several package.json files across different projects. The primary changes involve incrementing the versions of various dependencies, specifically the @effect/platform, @effect/platform-node, and effect packages. Additionally, the @effect/vitest package has been updated. These updates reflect minor improvements and bug fixes, with no changes made to other sections like scripts or configurations.

Changes

File Change Summary
examples/backend-adapters/server/package.json Updated dependencies: @effect/platform from 0.69.6 to 0.69.8, @effect/platform-node from 0.64.7 to 0.64.9, effect from 3.10.2 to 3.10.3
package.json Updated dependency: @effect/vitest from 0.13.1 to 0.13.3
packages/shared/package.json Updated dependency: effect from 3.10.2 to 3.10.3
packages/uploadthing/package.json Updated dependencies: @effect/platform from 0.69.6 to 0.69.8, effect from 3.10.2 to 3.10.3
packages/shared/src/error.ts Added import: import * as Predicate from "effect/Predicate"; and updated error handling logic
packages/shared/src/utils.ts Updated method signature for safeParseJSON, removed isObject and asArray functions
packages/uploadthing/src/client.ts Replaced asArray with Arr.ensure in upload handling functions
packages/uploadthing/src/sdk/index.ts Replaced asArray with Arr.ensure in multiple methods of UTApi class
packages/uploadthing/src/sdk/utils.ts Added import for Predicate and updated type checking in downloadFiles function

Assessment against linked issues

Objective Addressed Explanation
Ensure callbackUrl defaults are handled correctly in config (1027) The PR does not address the issue of handling callbackUrl: undefined.

Possibly related PRs

  • chore(release): 📦 version packages #970: This PR updates the uploadthing package to version 7.1.0, which includes dependency updates for @effect/platform and effect, directly related to the changes in the main PR that also updates these dependencies.
  • feat: add effect/Redacted #993: This PR introduces the effect/Redacted type to enhance the handling of sensitive information, which aligns with the updates in the main PR that also involves dependency updates for effect.
  • chore: update effect/platform past API changes #1005: This PR updates the uploadthing package to accommodate recent API changes in effect/platform, which is relevant as the main PR also updates the @effect/platform dependency.
  • chore: bump internal effect pacakge #1009: This PR continues the trend of updating the @effect/platform dependency, which is also reflected in the main PR's updates to the same package.
  • chore: bump eff #1015: This PR includes updates to the @effect/platform dependency, which is consistent with the changes made in the main PR regarding dependency updates.
  • fix: nuxt module not passing options correctly #1018: This PR addresses an issue with the Nuxt module not passing options correctly, which may relate to the overall functionality and configuration updates in the main PR that involve dependency management and module configurations.

Suggested labels

sdk, examples

Suggested reviewers

  • markflorkowski
  • t3dotgg

Poem

🐰 In the garden of code, we hop and play,
With versions updated, we brighten the day.
Dependencies dance, in a rhythmic tune,
Bugs take their leave, like flowers in bloom.
So here’s to the changes, both big and small,
A leap towards progress, let’s celebrate all! 🌼


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 25, 2024

Open in Stackblitz

More templates

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

commit: effdbe0

Copy link
Contributor

github-actions bot commented Oct 25, 2024

📦 Bundle size comparison

Bundle Size (gzip) Visualization
Main 27.20KB See Treemap 📊
PR (5c464eb) 27.50KB See Treemap 📊
Diff ↑299.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: 0

🧹 Outside diff range and nitpick comments (4)
packages/shared/src/error.ts (1)

84-91: LGTM with suggestions for improvement

The new validation logic using Effect predicates is more type-safe and explicit. Consider these optional improvements:

  1. Define a type for the response-like object structure
  2. Enhance the error message to include more context

Consider this enhancement:

+type ResponseLike = {
+  status: number;
+  statusText: string;
+};

 if (
   Predicate.isRecord(opts.cause) &&
   Predicate.isNumber(opts.cause.status) &&
   Predicate.isString(opts.cause.statusText)
 ) {
   this.cause = new Error(
-    `Response ${opts.cause.status} ${opts.cause.statusText}`,
+    `HTTP Error Response: ${opts.cause.status} ${opts.cause.statusText}`,
   );
packages/uploadthing/src/sdk/utils.ts (1)

84-84: LGTM: Improved type safety with Predicate.isRecord

The replacement of isObject with Predicate.isRecord enhances type safety while maintaining the same functionality. The predicate is used consistently for both URL extraction and property destructuring.

Consider adding a type annotation for better code clarity:

-        let url = Predicate.isRecord(_url) ? _url.url : _url;
+        let url: string | URL = Predicate.isRecord(_url) ? _url.url : _url;

Also applies to: 104-104

packages/shared/src/utils.ts (2)

Line range hint 171-179: Breaking change: safeParseJSON now only accepts ResponseEsque

The implementation looks good, but this is a breaking change as the function no longer accepts string input. Consider documenting this change in JSDoc.

Add JSDoc to document the breaking change:

+/**
+ * Safely parses JSON from a Response-like object
+ * @breaking Changed in version X.X.X to only accept ResponseEsque objects
+ */
export async function safeParseJSON<T>(
  input: ResponseEsque,
): Promise<T | Error> {

Migration to Effect utilities incomplete - remaining usages found

The verification revealed that isObject is still being used in the examples/minimal-expo project while the main packages have migrated to Effect's utilities. This indicates an inconsistency in the migration:

  • examples/minimal-expo/lib/utils.ts: Contains implementation of isObject
  • examples/minimal-expo/app/api/uploadthing+api.ts: Uses the local isObject utility

The main packages show proper migration to Effect utilities:

  • Multiple imports of effect/Predicate and effect/Array across core packages
  • No usage of old utilities in the main packages
🔗 Analysis chain

Line range hint 1-1: Verify impact of removed utility functions

The removal of isObject and asArray functions is a breaking change. Let's verify all usages have been properly migrated to Effect's utilities.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining usage of the removed functions
echo "Searching for potentially missed usages of removed functions..."
rg "isObject|asArray" --type ts

# Look for imports from effect/Predicate and effect/Array to verify migration
echo "Verifying migration to Effect utilities..."
rg "from ['\"](effect/(Predicate|Array))['\"]" --type ts

Length of output: 1122

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a0ddb0c and effdbe0.

📒 Files selected for processing (5)
  • packages/shared/src/error.ts (2 hunks)
  • packages/shared/src/utils.ts (1 hunks)
  • packages/uploadthing/src/client.ts (4 hunks)
  • packages/uploadthing/src/sdk/index.ts (7 hunks)
  • packages/uploadthing/src/sdk/utils.ts (3 hunks)
🔇 Additional comments (16)
packages/shared/src/error.ts (2)

2-2: LGTM: Good choice using Effect predicates

Using effect/Predicate for type validation is a more robust approach than manual object checks.


Line range hint 1-91: Verify location of callbackUrl fix

While these changes improve error handling, they don't directly address the PR's objective of fixing the callbackUrl parameter handling. Let's verify where that fix is implemented.

packages/uploadthing/src/sdk/utils.ts (2)

3-3: LGTM: Type-safe predicate import

The addition of Predicate from effect/Predicate provides a more robust type-safe alternative to the removed isObject utility.


Line range hint 1-190: Verify completeness of callbackUrl fix

While these changes improve type safety, they don't directly address the PR objective of fixing the callbackUrl handling issue mentioned in #1027.

Let's verify if there are other related changes:

packages/uploadthing/src/client.ts (4)

173-173: LGTM: Type-safe array handling with Arr.ensure

The migration from asArray to Arr.ensure improves type safety while maintaining the same functionality.


192-192: LGTM: Consistent array handling in resumeUpload

The use of Arr.ensure maintains consistency with the pauseUpload implementation and provides proper type safety.


229-229: LGTM: Type-safe completion handling

The migration to Arr.ensure completes the consistent pattern across all upload control functions while maintaining proper type safety and Promise handling.


1-1: Verify callbackUrl changes in other files

While the array handling improvements in this file look good, the PR objectives mention fixing a callbackUrl issue which isn't addressed here.

Let's verify where the callbackUrl changes are implemented:

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

20-20: LGTM: Import cleanup

Removal of the asArray import aligns with the migration to Arr.ensure from effect/Array.


130-130: LGTM: Consistent array handling

The use of Arr.ensure maintains type safety while aligning with the Effect-based architecture.


176-176: LGTM: Robust array handling

The implementation correctly handles both single and array inputs while maintaining error handling.


242-243: LGTM: Type-safe array handling

The implementation correctly handles array conversion for both fileKeys and customIds cases.


283-284: LGTM: Consistent implementation

The array handling mirrors the pattern used in deleteFiles, maintaining consistency across the codebase.


344-344: LGTM: Clean array conversion

The implementation maintains type safety while simplifying array handling.


Line range hint 435-439: LGTM: Efficient array processing

The implementation efficiently combines array conversion with mapping while maintaining type safety.


Line range hint 1-452: Verify alignment with PR objectives

The changes in this file focus on replacing asArray with Arr.ensure for array handling, but the PR objectives mention addressing a callbackUrl parameter issue. Please verify if additional changes are needed to address the callbackUrl functionality described in issue #1027.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[bug]: Setting callbackUrl: undefined doesn't use default value
1 participant