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

transloadit: Emit assembly progress events #4603

Merged
merged 7 commits into from
Sep 5, 2023

Conversation

Acconut
Copy link
Member

@Acconut Acconut commented Jul 26, 2023

This just a small PR which forwards the Assembly progress events from the WebSocket/SEE stream to the end user and also integrates the progress information into the status bar/dashboard. This feature is not yet available in production, but can already be tested out in staging.

Besides emitting the events, we could also consider additional integrations into Uppy, such as:

  • an option to enable progress events for an Assembly (by default Transloadit will not emit progress events if they are not enabled)

image

@Acconut
Copy link
Member Author

Acconut commented Sep 4, 2023

This feature is now available in production and can be enabled by adding emit_execution_progress: true to the assembly instructions. Therefore, we could move this PR forward. What do you think about this? Should this functionality only be enabled by a separate option in Uppy?

@Acconut Acconut marked this pull request as ready for review September 4, 2023 10:21
@Murderlon
Copy link
Member

Looks good and sorry for letting it hang for so long.

@Acconut
Copy link
Member Author

Acconut commented Sep 5, 2023

Thank you, no worries. Just two brief questions:

  • Should we also add this event to the TypeScript definitions at
    'transloadit:assembly-created': TransloaditAssemblyCreatedCallback
    ?
  • Can we mark this feature as experimental? The exact data format that is returned by the api2 could change, so users should not rely on it yet. Is it enough to just not document this feature for now?

@Murderlon
Copy link
Member

I assumed this is still experimental indeed, so we shouldn't type it because then we have to do a major to change the type. Same for docs I think.

We just shouldn't forget that we still need to add the types and docs.

@Acconut
Copy link
Member Author

Acconut commented Sep 5, 2023

That makes sense. Then this should be good to go now.

@Murderlon Murderlon merged commit 44d7a5e into main Sep 5, 2023
15 checks passed
@Murderlon Murderlon deleted the transloadit-assembly-progress branch September 5, 2023 07:46
github-actions bot added a commit that referenced this pull request Sep 5, 2023
| Package                | Version | Package                | Version |
| ---------------------- | ------- | ---------------------- | ------- |
| @uppy/angular          |   0.6.0 | @uppy/dashboard        |   3.5.2 |
| @uppy/aws-s3           |   3.3.0 | @uppy/transloadit      |   3.3.0 |
| @uppy/aws-s3-multipart |   3.6.0 | @uppy/tus              |   3.2.0 |
| @uppy/companion        |   4.8.2 | @uppy/utils            |   5.5.0 |
| @uppy/companion-client |   3.4.0 | @uppy/xhr-upload       |   3.4.0 |
| @uppy/core             |   3.5.0 | uppy                   |  3.15.0 |

- @uppy/transloadit: Emit assembly progress events (Marius / #4603)
- @uppy/transloadit: remove Socket.io (Antoine du Hamel / #4281)
- meta: example: update Angular example to 16.x (Antoine du Hamel / #4642)
- @uppy/angular: upgrade to Angular 16.x (Antoine du Hamel / #4642)
- @uppy/companion: refactor `getProtectedHttpAgent` to make TS happy (Antoine du Hamel / #4654)
- @uppy/companion: Alias "removeListener" as "off" in Redis emitter (Elliot Dickison / #4647)
- @uppy/aws-s3-multipart,@uppy/aws-s3,@uppy/companion-client,@uppy/core,@uppy/tus,@uppy/utils,@uppy/xhr-upload: Move remote file upload logic into companion-client (Merlijn Vos / #4573)
- @uppy/dashboard: when showAddFilesPanel  is true, aria-hidden should be the opposite (Artur Paikin / #4643)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants