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

example: showcase migration out of Robodog #4021

Merged
merged 6 commits into from Aug 22, 2022
Merged

example: showcase migration out of Robodog #4021

merged 6 commits into from Aug 22, 2022

Conversation

aduh95
Copy link
Member

@aduh95 aduh95 commented Aug 20, 2022

Here's a proposal to show case a migration out of Robodog. I'm not touching the HTML at all, as I expect that's how users would approach the transition (they don't want the content of their web page to change, just looking to replicate the features).

Not that currently it doesn't work, it crashes with errors such as TypeError: Cannot read properties of undefined (reading 'replace') or SyntaxError: Unexpected token u in JSON at position 0. @arturi can you take a look?

Co-authored-by: Artur Paikin <artur@arturpaikin.com>
@arturi
Copy link
Contributor

arturi commented Aug 21, 2022

Robodog had things built in that don't “just work” without, like using <input type="file"> as a button to open Uppy Dashboard modal.

I'll take a look and I see the point, but I spent a lot of time making sure the example works and is improved, and now I have to try and fix this one again. Hulk unhappy.

@aduh95
Copy link
Member Author

aduh95 commented Aug 21, 2022

Note that the improved example you work on is the one that will end up on the branch eventually, we just need this one to showcase a migration – and call out explicitly what things don't work anymore, so if someone is using an <input type=file> and there's no good replacement, at least they know.

@@ -0,0 +1,24 @@
# Robodog

This example shows all the different Robodog APIs in action on a single page.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This first sentence doesn't make sense here anymore

Suggested change
This example shows all the different Robodog APIs in action on a single page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean it still shows all the different Robodog APIs on a single page, I think we should keep it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it doesn't show different Robodog APIs, it shows alternatives. I think we either include that word or remove the sentence :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For folks following at home, this was discussed during the team meeting today, we agreed to keep this as a migration example, and therefor keep the Robodog references as it is aimed solely to Robodog users looking for a migration path out of Robodog now that we have deprecated it and plan on remove it on a followup PR.

})
.use(Dashboard, {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The next example is called "Form with Dashboard" so I would expect this is without Dashboard? Or delete this example altogether.


window.formUppyWithDashboard = formUppyWithDashboard

const dashboard = robodog.dashboard('#dashboard', {
/**
* Dashboard
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If every example shows Dashboard, then it feels a bit weird to now do that again?

* robodog.modal
*/
// /**
// * Dashboard Modal
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Dashboard modal has been clear for some time now. I would just add a comment in the other example that removing inline (or setting it to false) makes it modal.

})
.use(ProgressBar, { target: '#upload-progress' })

window.doUpload = (event) => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably needs explanation that this requires HTML as well, particularly a input type="file"

}
}

export default {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need a rollup config?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To define all the Rollup plugins this example use.

@arturi
Copy link
Contributor

arturi commented Aug 22, 2022

@Murderlon The actual example lives in #3946. This is just so we can point to something as an example of Robodg --> Uppy + Transloadit + RemoteSources conversion. @aduh95 asked not to change the original html or rename anything.

examples/transloadit/main.js Outdated Show resolved Hide resolved
@aduh95 aduh95 marked this pull request as ready for review August 22, 2022 13:18
@arturi arturi merged commit 089aaed into main Aug 22, 2022
@arturi arturi deleted the robodog-migration branch August 22, 2022 14:24
@github-actions github-actions bot mentioned this pull request Aug 22, 2022
github-actions bot added a commit that referenced this pull request Aug 22, 2022
**Migration guides:**
https://uppy.io/docs/migration-guides.html

| Package                   | Version | Package                   | Version |
| ------------------------- | ------- | ------------------------- | ------- |
| @uppy/angular             |   0.4.0 | @uppy/progress-bar        |   3.0.0 |
| @uppy/audio               |   1.0.0 | @uppy/provider-views      |   3.0.0 |
| @uppy/aws-s3              |   3.0.0 | @uppy/react               |   3.0.0 |
| @uppy/aws-s3-multipart    |   3.0.0 | @uppy/react-native        |   0.4.0 |
| @uppy/box                 |   2.0.0 | @uppy/redux-dev-tools     |   3.0.0 |
| @uppy/companion           |   4.0.0 | @uppy/remote-sources      |   1.0.0 |
| @uppy/companion-client    |   3.0.0 | @uppy/screen-capture      |   3.0.0 |
| @uppy/compressor          |   1.0.0 | @uppy/status-bar          |   3.0.0 |
| @uppy/core                |   3.0.0 | @uppy/store-default       |   3.0.0 |
| @uppy/dashboard           |   3.0.0 | @uppy/store-redux         |   3.0.0 |
| @uppy/drag-drop           |   3.0.0 | @uppy/svelte              |   2.0.0 |
| @uppy/drop-target         |   2.0.0 | @uppy/thumbnail-generator |   3.0.0 |
| @uppy/dropbox             |   3.0.0 | @uppy/transloadit         |   3.0.0 |
| @uppy/facebook            |   3.0.0 | @uppy/tus                 |   3.0.0 |
| @uppy/file-input          |   3.0.0 | @uppy/unsplash            |   3.0.0 |
| @uppy/form                |   3.0.0 | @uppy/url                 |   3.0.0 |
| @uppy/golden-retriever    |   3.0.0 | @uppy/utils               |   5.0.0 |
| @uppy/google-drive        |   3.0.0 | @uppy/vue                 |   1.0.0 |
| @uppy/image-editor        |   2.0.0 | @uppy/webcam              |   3.0.0 |
| @uppy/informer            |   3.0.0 | @uppy/xhr-upload          |   3.0.0 |
| @uppy/instagram           |   3.0.0 | @uppy/zoom                |   2.0.0 |
| @uppy/locales             |   3.0.0 | uppy                      |   3.0.0 |
| @uppy/onedrive            |   3.0.0 |                           |         |

- docs: Use RemoteSources in readme example (Artur Paikin / #4030)
- docs: Add migration guide for Uppy 3.x, Companion 4.x, and Robodog (Merlijn Vos / #3913)
- example: upgrade React example to use React 18 (Antoine du Hamel / #4002)
- meta: fix linter failures (Antoine du Hamel / #4029)
- @uppy/vue: move `@uppy/` packages to peer dependencies (Antoine du Hamel / #4024)
- @uppy/robodog: remove package (Antoine du Hamel / #3946)
- example: migrate `digitalocean-spaces` to ESM (Antoine du Hamel / #4015)
- example: replace Robodog example with Transloadit + RemoteSources + Form (Antoine du Hamel / #4027)
- website: replace Robodog example with Uppy plugins (Artur Paikin / #4026)
- @uppy/aws-s3,@uppy/tus,@uppy/xhr-upload: @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: `metaFields` -> `allowedMetaFields` (Merlijn Vos / #4023)
- example: showcase migration out of Robodog (Antoine du Hamel / #4021)
- example: fix Svelte dev mode (Antoine du Hamel / #4025)
- example: fix docs and env for Vite examples (Antoine du Hamel / #4018)
- @uppy/tus: avoid crashing when Tus client reports an error (Antoine du Hamel / #4019)
- @uppy/react: move `@uppy/` packages to peer dependencies (Antoine du Hamel / #4004)
- @uppy/core: core: uppy.addFile should accept browser File objects (Artur Paikin / #4020)
- example: fix svelte example (Antoine du Hamel / #4017)
- example: migrate `python-xhr` to ESM (Antoine du Hamel / #4010)
- example: migrate `php-xhr` to ESM (Antoine du Hamel / #4009)
- example: migrate `node-xhr` to ESM (Antoine du Hamel / #4008)
- example: migrate `xhr-bundle` to ESM (Antoine du Hamel / #4012)
- example: migrate `multiple-instances` to ESM (Antoine du Hamel / #4007)
- example: replace `transloadit-textarea` with `transloadit-markdown-bin` (Antoine du Hamel / #4013)
- example: add README to Svelte example (Antoine du Hamel / #4011)
- build: Remove size-limit for now (Artur Paikin / #4003)
- @uppy/core,@uppy/dashboard,@uppy/status-bar: Style tweaks: use all: initial + other resets (Artur Paikin / #3983)
- @uppy/aws-s3: aws-s3: fix incorrect comparison for `file-removed` (Merlijn Vos / #3962)
- example: update to new CDN export names (Antoine du Hamel / #4006)
- example: fix dependencies of `bundled` example (Antoine du Hamel / #4005)
- @uppy/tus: fix dependencies (Antoine du Hamel / #3923)
- @uppy/tus: add file argument to `onBeforeRequest` (Merlijn Vos / #3984)
- @uppy/utils: fix drop of multiple files on Chromium browsers (Antoine du Hamel / #3998)
- @uppy/angular: upgrade to Angular 14 (Antoine du Hamel / #3997)
- example: update Angular example to v14 (Antoine du Hamel / #3996)
- @uppy/utils: Fix @uppy/utils microtip.scss export (Merlijn Vos / #3995)
- docs: Companion: make streaming upload recommended & other docs tweaks (Mikael Finstad / #3994)

### 3.0.0-beta.5
### 3.0.0-beta.4
### 3.0.0-beta.3
### 3.0.0-beta.2
### 3.0.0-beta.1
### 3.0.0-beta
Murderlon added a commit that referenced this pull request Aug 23, 2022
* main: (63 commits)
  @uppy/angular: fix peer dependencies (#4035)
  uppy.io homepage: Add Tus
  Fix uppy.io homepage example
  Release: uppy@3.0.0 (#4031)
  Update README.md
  Update README.md
  meta: Use RemoteSources in readme example (#4030)
  Add migration guide for Uppy 3.x, Companion 4.x, and Robodog (#3913)
  example: upgrade React example to use React 18 (#4002)
  readme: Use new ESM syntax (#4028)
  fixup! meta: fix linter failures (#4029)
  @uppy/vue: move `@uppy/` packages to peer dependencies (#4024)
  meta: fix linter failures (#4029)
  @uppy/robodog: remove package (#3946)
  example: migrate `digitalocean-spaces` to ESM (#4015)
  example: replace Robodog example with Transloadit + RemoteSources + Form (#4027)
  website: replace Robodog example with Uppy plugins (#4026)
  @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: `metaFields` -> `allowedMetaFields` (#4023)
  example: showcase migration out of Robodog (#4021)
  example: fix Svelte dev mode (#4025)
  ...
HeavenFox pushed a commit to docsend/uppy that referenced this pull request Jun 27, 2023
**Migration guides:**
https://uppy.io/docs/migration-guides.html

| Package                   | Version | Package                   | Version |
| ------------------------- | ------- | ------------------------- | ------- |
| @uppy/angular             |   0.4.0 | @uppy/progress-bar        |   3.0.0 |
| @uppy/audio               |   1.0.0 | @uppy/provider-views      |   3.0.0 |
| @uppy/aws-s3              |   3.0.0 | @uppy/react               |   3.0.0 |
| @uppy/aws-s3-multipart    |   3.0.0 | @uppy/react-native        |   0.4.0 |
| @uppy/box                 |   2.0.0 | @uppy/redux-dev-tools     |   3.0.0 |
| @uppy/companion           |   4.0.0 | @uppy/remote-sources      |   1.0.0 |
| @uppy/companion-client    |   3.0.0 | @uppy/screen-capture      |   3.0.0 |
| @uppy/compressor          |   1.0.0 | @uppy/status-bar          |   3.0.0 |
| @uppy/core                |   3.0.0 | @uppy/store-default       |   3.0.0 |
| @uppy/dashboard           |   3.0.0 | @uppy/store-redux         |   3.0.0 |
| @uppy/drag-drop           |   3.0.0 | @uppy/svelte              |   2.0.0 |
| @uppy/drop-target         |   2.0.0 | @uppy/thumbnail-generator |   3.0.0 |
| @uppy/dropbox             |   3.0.0 | @uppy/transloadit         |   3.0.0 |
| @uppy/facebook            |   3.0.0 | @uppy/tus                 |   3.0.0 |
| @uppy/file-input          |   3.0.0 | @uppy/unsplash            |   3.0.0 |
| @uppy/form                |   3.0.0 | @uppy/url                 |   3.0.0 |
| @uppy/golden-retriever    |   3.0.0 | @uppy/utils               |   5.0.0 |
| @uppy/google-drive        |   3.0.0 | @uppy/vue                 |   1.0.0 |
| @uppy/image-editor        |   2.0.0 | @uppy/webcam              |   3.0.0 |
| @uppy/informer            |   3.0.0 | @uppy/xhr-upload          |   3.0.0 |
| @uppy/instagram           |   3.0.0 | @uppy/zoom                |   2.0.0 |
| @uppy/locales             |   3.0.0 | uppy                      |   3.0.0 |
| @uppy/onedrive            |   3.0.0 |                           |         |

- docs: Use RemoteSources in readme example (Artur Paikin / transloadit#4030)
- docs: Add migration guide for Uppy 3.x, Companion 4.x, and Robodog (Merlijn Vos / transloadit#3913)
- example: upgrade React example to use React 18 (Antoine du Hamel / transloadit#4002)
- meta: fix linter failures (Antoine du Hamel / transloadit#4029)
- @uppy/vue: move `@uppy/` packages to peer dependencies (Antoine du Hamel / transloadit#4024)
- @uppy/robodog: remove package (Antoine du Hamel / transloadit#3946)
- example: migrate `digitalocean-spaces` to ESM (Antoine du Hamel / transloadit#4015)
- example: replace Robodog example with Transloadit + RemoteSources + Form (Antoine du Hamel / transloadit#4027)
- website: replace Robodog example with Uppy plugins (Artur Paikin / transloadit#4026)
- @uppy/aws-s3,@uppy/tus,@uppy/xhr-upload: @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: `metaFields` -> `allowedMetaFields` (Merlijn Vos / transloadit#4023)
- example: showcase migration out of Robodog (Antoine du Hamel / transloadit#4021)
- example: fix Svelte dev mode (Antoine du Hamel / transloadit#4025)
- example: fix docs and env for Vite examples (Antoine du Hamel / transloadit#4018)
- @uppy/tus: avoid crashing when Tus client reports an error (Antoine du Hamel / transloadit#4019)
- @uppy/react: move `@uppy/` packages to peer dependencies (Antoine du Hamel / transloadit#4004)
- @uppy/core: core: uppy.addFile should accept browser File objects (Artur Paikin / transloadit#4020)
- example: fix svelte example (Antoine du Hamel / transloadit#4017)
- example: migrate `python-xhr` to ESM (Antoine du Hamel / transloadit#4010)
- example: migrate `php-xhr` to ESM (Antoine du Hamel / transloadit#4009)
- example: migrate `node-xhr` to ESM (Antoine du Hamel / transloadit#4008)
- example: migrate `xhr-bundle` to ESM (Antoine du Hamel / transloadit#4012)
- example: migrate `multiple-instances` to ESM (Antoine du Hamel / transloadit#4007)
- example: replace `transloadit-textarea` with `transloadit-markdown-bin` (Antoine du Hamel / transloadit#4013)
- example: add README to Svelte example (Antoine du Hamel / transloadit#4011)
- build: Remove size-limit for now (Artur Paikin / transloadit#4003)
- @uppy/core,@uppy/dashboard,@uppy/status-bar: Style tweaks: use all: initial + other resets (Artur Paikin / transloadit#3983)
- @uppy/aws-s3: aws-s3: fix incorrect comparison for `file-removed` (Merlijn Vos / transloadit#3962)
- example: update to new CDN export names (Antoine du Hamel / transloadit#4006)
- example: fix dependencies of `bundled` example (Antoine du Hamel / transloadit#4005)
- @uppy/tus: fix dependencies (Antoine du Hamel / transloadit#3923)
- @uppy/tus: add file argument to `onBeforeRequest` (Merlijn Vos / transloadit#3984)
- @uppy/utils: fix drop of multiple files on Chromium browsers (Antoine du Hamel / transloadit#3998)
- @uppy/angular: upgrade to Angular 14 (Antoine du Hamel / transloadit#3997)
- example: update Angular example to v14 (Antoine du Hamel / transloadit#3996)
- @uppy/utils: Fix @uppy/utils microtip.scss export (Merlijn Vos / transloadit#3995)
- docs: Companion: make streaming upload recommended & other docs tweaks (Mikael Finstad / transloadit#3994)

### 3.0.0-beta.5
### 3.0.0-beta.4
### 3.0.0-beta.3
### 3.0.0-beta.2
### 3.0.0-beta.1
### 3.0.0-beta
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.

None yet

3 participants