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

@uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: metaFields -> allowedMetaFields #4023

Merged
merged 8 commits into from Aug 22, 2022

Conversation

Murderlon
Copy link
Member

Change counterintuitive metaFields to allowedMetaFields

@Murderlon Murderlon added the 3.0 label Aug 22, 2022
@Murderlon Murderlon marked this pull request as draft August 22, 2022 10:20
@arturi
Copy link
Contributor

arturi commented Aug 22, 2022

Let’s add a warning about using the old option? If we don't want to support both, at least an error in console would save a lot of time for upgrading devs.

@Murderlon Murderlon changed the title @uppy/tus: metaFields -> allowedMetaFields @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: metaFields -> allowedMetaFields Aug 22, 2022
@Murderlon Murderlon marked this pull request as ready for review August 22, 2022 10:35
@Murderlon
Copy link
Member Author

Let’s add a warning about using the old option? If we don't want to support both, at least an error in console would save a lot of time for upgrading devs.

Done :)

packages/@uppy/aws-s3/src/index.js Outdated Show resolved Hide resolved
packages/@uppy/aws-s3/src/index.js Outdated Show resolved Hide resolved
packages/@uppy/tus/src/index.js Outdated Show resolved Hide resolved
packages/@uppy/xhr-upload/src/index.js Outdated Show resolved Hide resolved
@aduh95
Copy link
Member

aduh95 commented Aug 22, 2022

Left to update:

metaFields: pluginState.metaFields,
metaFields: this.opts.metaFields,
metaFields: (file) => {
metaFields: props.metaFields,
metaFields: ['assembly_url', 'filename', 'fieldname'],

@Murderlon
Copy link
Member Author

Murderlon commented Aug 22, 2022

Left to update:

You're mistaking metaFields here with actually adding metaFields, which is entirely different from allowedMetaFields :)

That said, I did forget one instance of it.

@arturi
Copy link
Contributor

arturi commented Aug 22, 2022

Yes, please don't remove/rename uppy.opts.metaFields by accident :)

@Murderlon Murderlon merged commit d7180db into main Aug 22, 2022
@Murderlon Murderlon deleted the tus-opt-metaFields branch August 22, 2022 14:48
@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)
  ...
@@ -66,12 +66,13 @@ uppy.use(AwsS3, {

Custom headers that should be sent along to [Companion][companion docs] on every request.

### `metaFields: []`
### `allowedMetaFields: null`
Copy link
Member

Choose a reason for hiding this comment

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

Why did change the docs to say the default is now null, and kept [] in the code? Which one did we mean?

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