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

Murderlon · 2022-08-22T10:18:17Z

Change counterintuitive metaFields to allowedMetaFields

arturi · 2022-08-22T10:21:28Z

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 · 2022-08-22T12:58:43Z

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

packages/@uppy/tus/src/index.js

packages/@uppy/xhr-upload/src/index.js

aduh95 · 2022-08-22T13:52:26Z

Left to update:

uppy/packages/@uppy/dashboard/src/Dashboard.jsx

Line 59 in 9724392

metaFields: [],

uppy/packages/@uppy/dashboard/src/Dashboard.jsx

Line 943 in 9724392

metaFields: pluginState.metaFields,

uppy/packages/@uppy/dashboard/src/Dashboard.jsx

Line 1002 in 9724392

metaFields: this.opts.metaFields,

uppy/packages/@uppy/dashboard/src/index.test.js

Line 109 in 5a8a8d3

metaFields: (file) => {

uppy/packages/@uppy/dashboard/src/components/FileList.jsx

Line 54 in 327509a

metaFields: props.metaFields,

uppy/packages/@uppy/dashboard/types/index.test-d.ts

Line 22 in b7ecab5

metaFields: [

uppy/packages/@uppy/react/src/DashboardModal.js

Line 190 in 9a213b5

metaFields: [],

uppy/packages/@uppy/transloadit/src/index.js

Line 796 in 1efa053

metaFields: ['assembly_url', 'filename', 'fieldname'],

Murderlon · 2022-08-22T13:54:38Z

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 · 2022-08-22T14:23:24Z

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

**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

* 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) ...

aduh95 · 2022-11-13T19:44:21Z

website/src/docs/aws-s3.md

@@ -66,12 +66,13 @@ uppy.use(AwsS3, {

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

-### `metaFields: []`
+### `allowedMetaFields: null`


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

**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

metaFields -> allowedMetaFields

baa33e2

Murderlon added the 3.0 label Aug 22, 2022

Murderlon requested review from arturi and aduh95 August 22, 2022 10:18

Murderlon marked this pull request as draft August 22, 2022 10:20

Murderlon added 2 commits August 22, 2022 12:33

Also change xhr-upload and aws-s3

fa26d41

Don't forgot types

cfd0cef

Murderlon changed the title ~~@uppy/tus: metaFields -> allowedMetaFields~~ @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: metaFields -> allowedMetaFields Aug 22, 2022

Murderlon marked this pull request as ready for review August 22, 2022 10:35

Murderlon added 2 commits August 22, 2022 12:37

Fix copy paste error in docs

ef71fb4

Throw error if old metaFields option is used

a4a0da6

aduh95 approved these changes Aug 22, 2022

View reviewed changes

packages/@uppy/aws-s3/src/index.js Outdated Show resolved Hide resolved

Murderlon commented Aug 22, 2022

View reviewed changes

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

Murderlon added 2 commits August 22, 2022 15:39

Apply suggestions from code review

4525ee0

Fix check

bb0f79d

Fix last instance of metaFields

07ffa17

arturi approved these changes Aug 22, 2022

View reviewed changes

Murderlon merged commit d7180db into main Aug 22, 2022

Murderlon deleted the tus-opt-metaFields branch August 22, 2022 14:48

github-actions bot mentioned this pull request Aug 22, 2022

Release: uppy@3.0.0 #4031

Merged

H4NG-MAN mentioned this pull request Aug 23, 2022

[Snyk] Security upgrade @uppy/companion from 0.17.5 to 4.0.0 H4NG-MAN/uppy#116

Open

snyk-bot mentioned this pull request Sep 26, 2022

[Snyk] Security upgrade @uppy/companion from 0.17.5 to 4.0.0 H4NG-MAN/uppy#123

Open

aduh95 reviewed Nov 13, 2022

View reviewed changes

H4NG-MAN mentioned this pull request Dec 4, 2022

[Snyk] Security upgrade @uppy/companion from 0.17.5 to 4.0.0 H4NG-MAN/uppy#159

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Murderlon commented Aug 22, 2022

arturi commented Aug 22, 2022

Murderlon commented Aug 22, 2022

aduh95 commented Aug 22, 2022

Murderlon commented Aug 22, 2022 •

edited

Loading

arturi commented Aug 22, 2022

aduh95 Nov 13, 2022

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

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

Conversation

Murderlon commented Aug 22, 2022

arturi commented Aug 22, 2022

Murderlon commented Aug 22, 2022

aduh95 commented Aug 22, 2022

Murderlon commented Aug 22, 2022 • edited Loading

arturi commented Aug 22, 2022

aduh95 Nov 13, 2022

Choose a reason for hiding this comment

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

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

Murderlon commented Aug 22, 2022 •

edited

Loading