Implement Uppy uploader metadata editing and event handling by corovcam · Pull Request #2288 · inveniosoftware/invenio-rdm-records

corovcam · 2026-03-26T12:51:00Z

Replaced: #2278

❤️ Thank you for your contribution!

Description

Implemented modular metadata editing support in the Uppy uploader and refactored event handling for better extensibility and maintainability.

Main changes:

Extracted metadata-related logic into reusable utilities.
Extracted event-related logic into a separate module.
Introduced a centralized Uppy events enum and replaced hardcoded event strings.
Made Dashboard metadata fields optional and extensible so integrators can provide custom renderer behavior via allowed metadata field configuration.
Improved metadata default value processing before upload.
Updated uploader prop type definitions to correctly document metadata field configuration and event-related props.
Added JSDoc documentation for metadata and event utilities.

Checklist

Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:

I'm aware of the code of conduct.
I've created logical separate commits and followed the commit message format.
I've added relevant test cases.
I've added relevant documentation.
I've marked translation strings.
I've identified the copyright holder(s) and updated copyright headers for touched files (>15 lines contributions).
I've NOT included third-party code (copy/pasted source code or new dependencies).
- If you have added third-party code (copy/pasted or new dependencies), please reach out to an architect on Discord.

Frontend

I've followed the CSS/JS and React guidelines.
I've followed the web accessibility guidelines.
I've followed the user interface guidelines.

Reminder

By using GitHub, you have already agreed to the GitHub’s Terms of Service including that:

You license your contribution under the same terms as the current repository’s license.
You agree that you have the right to license your contribution under the current repository’s license.

…ling and utilities

…related tests

… management

mirekys · 2026-03-31T12:48:15Z

+
+  Object.keys(files).forEach((fileID) => {
+    const file = files[fileID];
+    file.meta["metadata"] = file.meta?.metadata || {};


direct mutation of file.meta - should be immutable

Well, originally file.meta is used by Uppy to update values from UI fields in metadata editor, but we also use file.meta to add additional info during multipart handling logic (e.g. parts). To distinguish between the Uppy and Multipart logic, I rather copied the Uppy fields into file.meta.metadata, and changed a bit Multipart uppy state updates to not override it.

mirekys · 2026-03-31T12:51:23Z

  mapDispatchToProps
 )(UppyUploaderComponent);
+
+export { UPPY_EVENTS } from "./events";


Only used internally, is there a reason to export for other parts of UI?

To make available events a public enum. Not just a string literal. But it's optional ofc.

mirekys · 2026-03-31T19:02:46Z

+      onBeforeUpload: (files) => {
+        return activeAllowedMetaFields && activeAllowedMetaFields.length > 0 
+          ? onBeforeUploadProcessMetaFields(files, activeAllowedMetaFields)
+          : files;


Shadows variable from outer scope

mirekys · 2026-04-01T07:24:56Z

This would require also a PR to InvenioRDM docs. Explaining, how instance admins could add certain metadata fields to certain file type: https://github.com/inveniosoftware/docs-invenio-rdm/blob/2a8d853626d756717e692c035b80ea24483143f2/docs/operate/customize/file-uploads/uploader.md?plain=1

mirekys · 2026-04-02T08:34:40Z

This would require also a PR to InvenioRDM docs. Explaining, how instance admins could add certain metadata fields to certain file type: https://github.com/inveniosoftware/docs-invenio-rdm/blob/2a8d853626d756717e692c035b80ea24483143f2/docs/operate/customize/file-uploads/uploader.md?plain=1

Currently it is unclear how metadata fields could be passed to deposit form config, If, say, I want to annotate all .txt files in my RDM instance to have a metadata.description field of type string, how do i do it?

mirekys · 2026-04-02T08:36:01Z

+ * @property {function(Object, Function): Object} [metaFields[].render] - Optional custom render function for advanced UI rendering of the field using Preact `h` function. If not provided, a standard text input will be rendered when `name` is set. See {@link https://uppy.io/docs/dashboard/#metafields|Uppy Dashboard metaFields documentation}.
+ * @property {function(Object): Boolean} [metaFields[].condition] - Optional function to conditionally attach or render the field based on the respective file properties (e.g. file.type).
+ */
+export const defaultAllowedMetaFields = [


Commented out example doesn't work, remove or fix (input is not writeable):

Screen.Recording.2026-04-02.at.10.35.29.mov

It does not work, because of inveniosoftware/invenio-app-rdm#3386. Both PRs need to be merged to make Uppy components display correctly.

My bad, thanks! :)

…process

mirekys · 2026-04-10T15:16:10Z

+ * @param {Object} uppyFiles - The Uppy files object dictionary.
+ * @param {Object} invenioFiles - The files object from Invenio.
+ * @param {Array<Object>} allowedMetaFields - Configuration for metadata fields.
+ * @returns {Object} Updated files dictionary.


Type inconsistency, the function returns updatedFiles but the docstring doesn’t fully explain when/why it’s needed. Could potentially return an empty object if there are no uppyFiles.

mirekys · 2026-04-10T15:17:38Z

   *  - The default implementation calls out to Companion’s S3 signing endpoints.
   */
  async completeMultipartUpload(file) {
+    if (file.meta?.metadata && Object.keys(file.meta.metadata).length > 0 && this.opts.updateFileMetadata) {


If metadata update fails, the whole upload will fail without calling finalize, will it be properly cleaned up? I think finalize will handle cleanup properly if it fails

mirekys · 2026-04-10T15:19:02Z

+    uppy.setOptions({
+      onBeforeUpload: (uppyFiles) => {
+        return activeAllowedMetaFields && activeAllowedMetaFields.length > 0 
+          ? onBeforeUploadProcessMetaFields(uppyFiles, files, activeAllowedMetaFields)


Files from closure not in deps, could get stale

corovcam · 2026-04-17T08:47:11Z

Added docs for this: inveniosoftware/docs-invenio-rdm#926

corovcam added 3 commits March 26, 2026 10:05

feat(UppyUploader): enhance file metadata editing with new event hand…

53f0ab8

…ling and utilities

feat(UppyUploader): implement file metadata update functionality and …

21c80bf

…related tests

feat(UppyUploader): refactor file metadata handling and improve event…

0cdcc20

… management

mirekys reviewed Mar 31, 2026

View reviewed changes

mirekys reviewed Apr 1, 2026

View reviewed changes

mirekys reviewed Apr 2, 2026

View reviewed changes

feat(UppyUploader): enhance file metadata handling and update upload …

2d78c91

…process

mirekys reviewed Apr 10, 2026

View reviewed changes

corovcam mentioned this pull request Apr 17, 2026

Feat: Documents Uppy file metadata configuration inveniosoftware/docs-invenio-rdm#926

Open

4 tasks

Conversation

corovcam commented Mar 26, 2026

Description

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

corovcam Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mirekys commented Apr 1, 2026

Uh oh!

mirekys commented Apr 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

corovcam commented Apr 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

corovcam Apr 1, 2026 •

edited

Loading