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

Rename POST_RECEIVE_V2 to POST_RECEIVE #724

Open
wants to merge 2 commits into
base: request-runtimes
Choose a base branch
from

Conversation

Murderlon
Copy link
Member

Do not merge before #710

POST_RECEIVE is called every time an upload finished writing to the store. This event is emitted whenever the request handling is completed (which is the same as onUploadFinish, almost the same as POST_FINISH), whereas the POST_RECEIVE_V2 event is emitted while the request is being handled.

POST_RECEIVE has been marked deprecated for a long time.

@Murderlon Murderlon added the Breaking change This requires a semver major release label Feb 12, 2025
@Murderlon Murderlon self-assigned this Feb 12, 2025
Copy link

changeset-bot bot commented Feb 12, 2025

🦋 Changeset detected

Latest commit: da2fe87

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@tus/server Major
@tus/utils Minor
@tus/gcs-store Patch
@tus/azure-store Patch
@tus/file-store Patch
@tus/s3-store Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

coderabbitai bot commented Feb 12, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. 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.
    • 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.

@mitjap
Copy link
Collaborator

mitjap commented Feb 12, 2025

It would be nice to use a different event name for all who are still using deprecated event name. Or is it OK for user to silently transition to use new event?

@Murderlon
Copy link
Member Author

Murderlon commented Feb 12, 2025

POST_RECEIVE was a mistake from me when I implemented all events at the same time. The only reason is to do something on progress instead of on finish (but the implementation was in fact on finish). If some people never got the deprecation warning and blindly update to the next major version without checking any release notes, then it will still work as expected as long as you wrote the code with the assumption it fires on progress (idempotent and where a lost event doesn't matter).

I think the best way forward is to rename. Otherwise it means removing two events and introducing a new one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking change This requires a semver major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants