Provider user sessions #4619

mifi · 2023-08-14T08:30:42Z

This PR brings some improvements, bux fixes, as well as the feature: Per-provider auth state as discussed in #4551 (comment) - this enables implementing providers like webdav+oauth, webdav(no auth) and ftp

Allow creating plugins without OAuth flows, but instead with simple auth flows (auth happens through companion)
Allow sending extra data along with simple auth flows that can be used by companion providers after auth success
Allow sending extra parameters along with OAuth flows that will be used during auth, and can be used after auth success (e.g. dynamic domain needed for webdav oauth)
Allow creating custom auth forms per provider, with preact components
New concept "simple auth" - authentication that happens immediately (in one http request) without redirecting to any third party. da67ac9
companion can send custom error data back to Uppy (useful for notifying user about authentication errors and other useful errors)

Note: This PR is easier reviewed commit-by-commit

closes #4555 #4551

example implementations:

ftp draft: implement ftp provider poc #4620
webdav Draft: Webdav provider poc #4621

Edit: TODO:

improve the simpleAuth API in the client
allow provider to specify content type in thumbnail api Provider user sessions #4619 (comment)
investigate merging SearchProviderViews into ProviderViews, based on this PR (separate PR)

related #4426

not critical but some browsers might have problems

so we don't have to decode/decrypt/encode/encrypt so many times

New concept "simple auth" - authentication that happens immediately (in one http request) without redirecting to any third party. uppyAuthToken initially used to simply contain an encrypted & json encoded OAuth2 access_token for a specific provider. Then we added refresh tokens as well inside uppyAuthToken #4448. Now we also allow storing other state or parameters needed for that specific provider, like username, password, host name, webdav URL etc... This is needed for providers like webdav, ftp etc, where the user needs to give some more input data while authenticating Companion: - `providerTokens` has been renamed to `providerUserSession` because it now includes not only tokens, but a user's session with a provider. Companion `Provider` class: - New `hasSimpleAuth` static boolean property - whether this provider uses simple auth - uppyAuthToken expiry default 24hr again for providers that don't support refresh tokens - make uppyAuthToken expiry configurable per provider - new `authStateExpiry` static property (defaults to 24hr) - new static property `grantDynamicToUserSession`, allows providers to specify which state from Grant `dynamic` to include into the provider's `providerUserSession`.

also for thumbnails for consistency

it wasn't returning the status code (like `got` does on error) it's needed to respond properly with a http error

instead log error and show the key this in on par with other i18n frameworks

and don't replace the whole view with a loader when plugin state loading it will cause auth views to lose state an inter-view loading text looks much more graceful and is how SearchProviderView works too

add support for passing objects and messages from companion to uppy this allows companion to for example give a more detailed error when authenticating

don't force the user to use html form and use preact for it, for flexibility

dschmidt

Looking great! Thanks for taking this over <3

packages/@uppy/companion/src/server/controllers/thumbnail.js

# Conflicts: # packages/@uppy/companion/src/server/controllers/refresh-token.js # packages/@uppy/companion/src/server/provider/index.js

this is useful because: // onedrive gives some errors here that the user might want to know about // e.g. these happen if you try to login to a users in an organization, // without an Office365 licence or OneDrive account setup completed // 400: Tenant does not have a SPO license // 403: You do not have access to create this personal site or you do not have a valid license

# Conflicts: # packages/@uppy/companion-client/src/Provider.js # packages/@uppy/companion/src/server/provider/error.d.ts

Co-authored-by: Antoine du Hamel <[email protected]>

Murderlon

I think we're still low on tests but don't want to block this forever.

see discussion here: #4619 (comment)

mifi · 2023-12-05T07:59:40Z

I have now rewritten errors to not use instanceof, but instead duck typing. Final round of reviews please, then I think we can merge! You only need to look at commits after "Dec 1, 2023"

packages/@uppy/companion/src/server/Uploader.js

packages/@uppy/companion/src/server/provider/error.js

packages/@uppy/companion/src/server/provider/providerErrors.js

packages/@uppy/provider-views/src/ProviderView/ProviderView.jsx

packages/@uppy/utils/src/UserFacingApiError.js

Co-authored-by: Antoine du Hamel <[email protected]>

dschmidt · 2023-12-05T23:18:56Z

🎉 🎉 🎉

* remove useless line * fix broken cookie removal logic related #4426 * fix mime type of thumbnails not critical but some browsers might have problems * simplify/speedup token generation so we don't have to decode/decrypt/encode/encrypt so many times * use instanceof instead of prop check * Implement alternative provider auth New concept "simple auth" - authentication that happens immediately (in one http request) without redirecting to any third party. uppyAuthToken initially used to simply contain an encrypted & json encoded OAuth2 access_token for a specific provider. Then we added refresh tokens as well inside uppyAuthToken #4448. Now we also allow storing other state or parameters needed for that specific provider, like username, password, host name, webdav URL etc... This is needed for providers like webdav, ftp etc, where the user needs to give some more input data while authenticating Companion: - `providerTokens` has been renamed to `providerUserSession` because it now includes not only tokens, but a user's session with a provider. Companion `Provider` class: - New `hasSimpleAuth` static boolean property - whether this provider uses simple auth - uppyAuthToken expiry default 24hr again for providers that don't support refresh tokens - make uppyAuthToken expiry configurable per provider - new `authStateExpiry` static property (defaults to 24hr) - new static property `grantDynamicToUserSession`, allows providers to specify which state from Grant `dynamic` to include into the provider's `providerUserSession`. * refactor * use respondWithError also for thumbnails for consistency * fix prepareStream it wasn't returning the status code (like `got` does on error) it's needed to respond properly with a http error * don't throw when missing i18n key instead log error and show the key this in on par with other i18n frameworks * fix bugged try/catch * allow aborting login too and don't replace the whole view with a loader when plugin state loading it will cause auth views to lose state an inter-view loading text looks much more graceful and is how SearchProviderView works too * add json http error support add support for passing objects and messages from companion to uppy this allows companion to for example give a more detailed error when authenticating * don't tightly couple auth form with html form don't force the user to use html form and use preact for it, for flexibility * fix i18n * make contentType parameterized * allow sending certain errors to the user this is useful because: // onedrive gives some errors here that the user might want to know about // e.g. these happen if you try to login to a users in an organization, // without an Office365 licence or OneDrive account setup completed // 400: Tenant does not have a SPO license // 403: You do not have access to create this personal site or you do not have a valid license * sending certain onedrive errors to the user this is useful because: // onedrive gives some errors here that the user might want to know about // e.g. these happen if you try to login to a users in an organization, // without an Office365 licence or OneDrive account setup completed // 400: Tenant does not have a SPO license // 403: You do not have access to create this personal site or you do not have a valid license * don't have default content-type * make a loginSimpleAuth api too * make removeAuthToken protected (cherry picked from commit 4be2b6f) * fix lint * run yarn format * Apply suggestions from code review Co-authored-by: Antoine du Hamel <[email protected]> * fix broken merge conflict * improve inheritance * fix bug * fix bug with dynamic grant config * use duck typing for error checks see discussion here: #4619 (comment) * Apply suggestions from code review Co-authored-by: Antoine du Hamel <[email protected]> * fix broken lint fix script * fix broken merge code * try to fix flakey tets * fix lint --------- Co-authored-by: Antoine du Hamel <[email protected]>

* 4.x: meta: enable CI on `4.x` branch @uppy/aws-s3: change Companion URL in tests @uppy/set-state: fix types Provider user sessions (#4619)

* remove useless line * fix broken cookie removal logic related #4426 * fix mime type of thumbnails not critical but some browsers might have problems * simplify/speedup token generation so we don't have to decode/decrypt/encode/encrypt so many times * use instanceof instead of prop check * Implement alternative provider auth New concept "simple auth" - authentication that happens immediately (in one http request) without redirecting to any third party. uppyAuthToken initially used to simply contain an encrypted & json encoded OAuth2 access_token for a specific provider. Then we added refresh tokens as well inside uppyAuthToken #4448. Now we also allow storing other state or parameters needed for that specific provider, like username, password, host name, webdav URL etc... This is needed for providers like webdav, ftp etc, where the user needs to give some more input data while authenticating Companion: - `providerTokens` has been renamed to `providerUserSession` because it now includes not only tokens, but a user's session with a provider. Companion `Provider` class: - New `hasSimpleAuth` static boolean property - whether this provider uses simple auth - uppyAuthToken expiry default 24hr again for providers that don't support refresh tokens - make uppyAuthToken expiry configurable per provider - new `authStateExpiry` static property (defaults to 24hr) - new static property `grantDynamicToUserSession`, allows providers to specify which state from Grant `dynamic` to include into the provider's `providerUserSession`. * refactor * use respondWithError also for thumbnails for consistency * fix prepareStream it wasn't returning the status code (like `got` does on error) it's needed to respond properly with a http error * don't throw when missing i18n key instead log error and show the key this in on par with other i18n frameworks * fix bugged try/catch * allow aborting login too and don't replace the whole view with a loader when plugin state loading it will cause auth views to lose state an inter-view loading text looks much more graceful and is how SearchProviderView works too * add json http error support add support for passing objects and messages from companion to uppy this allows companion to for example give a more detailed error when authenticating * don't tightly couple auth form with html form don't force the user to use html form and use preact for it, for flexibility * fix i18n * make contentType parameterized * allow sending certain errors to the user this is useful because: // onedrive gives some errors here that the user might want to know about // e.g. these happen if you try to login to a users in an organization, // without an Office365 licence or OneDrive account setup completed // 400: Tenant does not have a SPO license // 403: You do not have access to create this personal site or you do not have a valid license * make `authProvider` consistent always use the static property ignoring the instance propety fixes #4460 * fix bug * fix test also * don't have default content-type * make a loginSimpleAuth api too * make removeAuthToken protected (cherry picked from commit 4be2b6f) * fix lint * run yarn format * Apply suggestions from code review Co-authored-by: Antoine du Hamel <[email protected]> * fix broken merge conflict * improve inheritance * fix bug * fix bug with dynamic grant config * use duck typing for error checks see discussion here: #4619 (comment) * Apply suggestions from code review Co-authored-by: Antoine du Hamel <[email protected]> * fix broken lint fix script * fix broken merge code * try to fix flakey tets * fix lint * fix merge issue --------- Co-authored-by: Antoine du Hamel <[email protected]>

| Package | Version | Package | Version | | ---------------------- | ------- | ---------------------- | ------- | | @uppy/aws-s3 | 3.6.0 | @uppy/instagram | 3.2.0 | | @uppy/aws-s3-multipart | 3.10.0 | @uppy/onedrive | 3.2.0 | | @uppy/box | 2.2.0 | @uppy/provider-views | 3.8.0 | | @uppy/companion | 4.12.0 | @uppy/store-default | 3.2.0 | | @uppy/companion-client | 3.7.0 | @uppy/tus | 3.5.0 | | @uppy/core | 3.8.0 | @uppy/url | 3.5.0 | | @uppy/dropbox | 3.2.0 | @uppy/utils | 5.7.0 | | @uppy/facebook | 3.2.0 | @uppy/xhr-upload | 3.6.0 | | @uppy/google-drive | 3.4.0 | @uppy/zoom | 2.2.0 | | @uppy/image-editor | 2.4.0 | uppy | 3.21.0 | - @uppy/provider-views: fix uploadRemoteFile undefined (Mikael Finstad / #4814) - @uppy/companion: fix double tus uploads (Mikael Finstad / #4816) - @uppy/companion: fix accelerated endpoints for presigned POST (Mikael Finstad / #4817) - @uppy/companion: fix `authProvider` property inconsistency (Mikael Finstad / #4672) - @uppy/companion: send certain onedrive errors to the user (Mikael Finstad / #4671) - meta: fix typo in `lockfile_check.yml` name (Antoine du Hamel) - @uppy/aws-s3: change Companion URL in tests (Antoine du Hamel) - @uppy/set-state: fix types (Antoine du Hamel) - @uppy/companion: Provider user sessions (Mikael Finstad / #4619) - meta: fix `js2ts` script on Node.js 20+ (Merlijn Vos / #4802) - @uppy/companion-client: avoid unnecessary preflight requests (Antoine du Hamel / #4462) - meta: Migrate to AWS-SDK V3 syntax (Artur Paikin / #4810) - @uppy/utils: fix import in test files (Antoine du Hamel / #4806) - @uppy/core: Fix onBeforeFileAdded with Golden Retriever (Merlijn Vos / #4799) - @uppy/image-editor: respect `cropperOptions.initialAspectRatio` (Lucklj521 / #4805)

mifi added 14 commits August 9, 2023 16:06

remove useless line

df98cca

fix broken cookie removal logic

9ccf2ae

related #4426

fix mime type of thumbnails

04128f9

not critical but some browsers might have problems

simplify/speedup token generation

9ceac7c

so we don't have to decode/decrypt/encode/encrypt so many times

use instanceof instead of prop check

600b2d0

refactor

7d59489

use respondWithError

ab06da6

also for thumbnails for consistency

fix prepareStream

16d4e3f

it wasn't returning the status code (like `got` does on error) it's needed to respond properly with a http error

don't throw when missing i18n key

2092387

instead log error and show the key this in on par with other i18n frameworks

fix bugged try/catch

f575dbc

allow aborting login too

754e2e0

and don't replace the whole view with a loader when plugin state loading it will cause auth views to lose state an inter-view loading text looks much more graceful and is how SearchProviderView works too

add json http error support

6441123

add support for passing objects and messages from companion to uppy this allows companion to for example give a more detailed error when authenticating

don't tightly couple auth form with html form

f503d1f

don't force the user to use html form and use preact for it, for flexibility

This was referenced Aug 14, 2023

draft: implement ftp provider poc #4620

Draft

Draft: Webdav provider poc #4621

Draft

@uppy/provider-view: allow apps to render custom forms in AuthView #4555

Closed

@uppy/companion,@uppy/companion-client: pass query params along more consistently #4551

Closed

dschmidt reviewed Aug 14, 2023

View reviewed changes

packages/@uppy/companion/src/server/controllers/thumbnail.js Outdated Show resolved Hide resolved

mifi added 2 commits August 14, 2023 22:15

fix i18n

272e3d1

make contentType parameterized

f2e5aa4

dschmidt reviewed Aug 14, 2023

View reviewed changes

packages/@uppy/companion/src/server/controllers/thumbnail.js Outdated Show resolved Hide resolved

mifi added 3 commits September 6, 2023 21:46

merge main

8016a5d

Merge branch 'main' into provider-user-sessions

9f160f4

# Conflicts: # packages/@uppy/companion/src/server/controllers/refresh-token.js # packages/@uppy/companion/src/server/provider/index.js

This was referenced Sep 6, 2023

send certain onedrive errors to the user #4671

Merged

@uppy/companion: fix authProvider property inconsistency #4672

Merged

mifi added 3 commits September 7, 2023 00:10

don't have default content-type

3166db9

make a loginSimpleAuth api too

5c20186

Merge branch 'main' into provider-user-sessions

b33f5b1

# Conflicts: # packages/@uppy/companion-client/src/Provider.js # packages/@uppy/companion/src/server/provider/error.d.ts

mifi and others added 2 commits November 29, 2023 11:59

Apply suggestions from code review

38eee72

Co-authored-by: Antoine du Hamel <[email protected]>

fix broken merge conflict

70a7a48

Murderlon approved these changes Nov 29, 2023

View reviewed changes

mifi added 4 commits December 1, 2023 14:41

improve inheritance

0d81a9b

fix bug

96eb565

fix bug with dynamic grant config

67d8595

use duck typing for error checks

5025a73

see discussion here: #4619 (comment)

aduh95 reviewed Dec 5, 2023

View reviewed changes

packages/@uppy/companion/src/server/Uploader.js Outdated Show resolved Hide resolved

aduh95 reviewed Dec 5, 2023

View reviewed changes

packages/@uppy/companion/src/server/Uploader.js Outdated Show resolved Hide resolved

aduh95 reviewed Dec 5, 2023

View reviewed changes

mifi and others added 4 commits December 5, 2023 19:00

Apply suggestions from code review

761dcdc

Co-authored-by: Antoine du Hamel <[email protected]>

Merge branch 'main' into provider-user-sessions

95c8e38

fix broken lint fix script

64ce471

fix broken merge code

654da1a

mifi requested a review from aduh95 December 5, 2023 13:29

mifi added 2 commits December 5, 2023 23:01

try to fix flakey tets

a69a1fe

fix lint

6d766cb

aduh95 approved these changes Dec 5, 2023

View reviewed changes

aduh95 merged commit ec4bc58 into main Dec 5, 2023
20 checks passed

aduh95 deleted the provider-user-sessions branch December 5, 2023 21:55

mifi restored the provider-user-sessions branch December 7, 2023 14:06

mifi deleted the provider-user-sessions branch December 7, 2023 14:29

Murderlon added a commit that referenced this pull request Dec 7, 2023

Merge branch '4.x' into ts-core

9751834

* 4.x: meta: enable CI on `4.x` branch @uppy/aws-s3: change Companion URL in tests @uppy/set-state: fix types Provider user sessions (#4619)

github-actions bot mentioned this pull request Dec 12, 2023

Release: [email protected] #4823

Merged

JammingBen mentioned this pull request May 2, 2024

Remove Uppy fork and use upstream implementation owncloud/web#10868

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provider user sessions #4619

Provider user sessions #4619

mifi commented Aug 14, 2023 •

edited

Loading

dschmidt left a comment

Murderlon left a comment

mifi commented Dec 5, 2023

dschmidt commented Dec 5, 2023

Provider user sessions #4619

Provider user sessions #4619

Conversation

mifi commented Aug 14, 2023 • edited Loading

dschmidt left a comment

Choose a reason for hiding this comment

Murderlon left a comment

Choose a reason for hiding this comment

mifi commented Dec 5, 2023

dschmidt commented Dec 5, 2023

mifi commented Aug 14, 2023 •

edited

Loading