feat(remix-node): callback functions that enable the integration of upload progress tracking

[akoenig]

I needed a method to tap into the real-time progress of file uploads, enabling me to enhance the user experience by streaming the live upload progress to my users. I documented this process in a blog post and believe that contributing these changes could be valuable.

• Docs (JSDoc for the newly added callback functions)

Testing Strategy:

Create a new fileUploadHandler, define the callback functions and see the progress printed via console.log:

createFileUploadHandler({
  onProgress({ name, filename, contentType, uploadedBytes }) {
    console.log(`Uploaded ${uploadedBytes} bytes.`);
  },
  onDone({ name, filename, contentType, uploadedBytes }) {
    console.log(`Successfully uploaded ${filename}.`);
  }
});

[remix-cla-bot]

Hi @akoenig,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

[changeset-bot]

⚠️ No Changeset found

Latest commit: bf97587

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

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

[github-actions]

Thank you for opening this pull request, and our apologies we haven't gotten around to it yet!

With the release of React Router v7 we are sun-setting continued development/maintenance on Remix v2. If you have not already upgraded to React Router v7, we recommend you do so. We've tried to make the upgrade process as smooth as possible with our Future Flags. We are now in the process of cleaning up outdated issues and pull requests to improve the overall hygiene of our repositories.

We plan to continue to address 2 types of issues in Remix v2:

• Bugs that pose security concerns
• Bugs that prevent upgrading to React Router v7

If you believe this pull request meets one of those criteria, please respond or create a new pull request so it pops up on our radar (since github notifications may get lost in the noise 😕).

For all other issues/changes, ongoing maintenance will be happening in React Router v7, so:

• If this is a bug fix, please reopen against React Router v7
• If this is a new feature, please open a new Proposal Discussion in React Router, and if it gets enough community support it can be considered for implementation

If you have any questions you can always reach out on Discord. Thanks again for providing feedback and helping us make our framework even better!