add COMPANION_AWS_FORCE_PATH_STYLE support #5066
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Diff output filesdiff --git a/packages/@uppy/companion/lib/server/s3-client.js b/packages/@uppy/companion/lib/server/s3-client.js
index 7ff225f..9d6827e 100644
--- a/packages/@uppy/companion/lib/server/s3-client.js
+++ b/packages/@uppy/companion/lib/server/s3-client.js
@@ -30,6 +30,7 @@ module.exports = (companionOptions, createPresignedPostMode = false) => {
/** @type {import('@aws-sdk/client-s3').S3ClientConfig} */
let s3ClientOptions = {
region: s3.region,
+ forcePathStyle: Boolean(s3.forcePathStyle),
};
if (s3.useAccelerateEndpoint) {
// https://github.com/transloadit/uppy/issues/4809#issuecomment-1847320742
diff --git a/packages/@uppy/companion/lib/standalone/helper.js b/packages/@uppy/companion/lib/standalone/helper.js
index d42c91c..878b711 100644
--- a/packages/@uppy/companion/lib/standalone/helper.js
+++ b/packages/@uppy/companion/lib/standalone/helper.js
@@ -124,6 +124,7 @@ const getConfigFromEnv = () => {
useAccelerateEndpoint: process.env.COMPANION_AWS_USE_ACCELERATE_ENDPOINT === "true",
expires: parseInt(process.env.COMPANION_AWS_EXPIRES || "800", 10),
acl: process.env.COMPANION_AWS_ACL,
+ forcePathStyle: process.env.COMPANION_AWS_FORCE_PATH_STYLE === "true",
},
server: {
host: process.env.COMPANION_DOMAIN, |
mifi
reviewed
Apr 16, 2024
| @@ -29,6 +29,7 @@ module.exports = (companionOptions, createPresignedPostMode = false) => { | |||
| /** @type {import('@aws-sdk/client-s3').S3ClientConfig} */ | |||
| let s3ClientOptions = { | |||
| region: s3.region, | |||
| forcePathStyle: Boolean(s3.forcePathStyle) | |||
There was a problem hiding this comment.
why do we need to convert it to a boolean?
Suggested change
| forcePathStyle: Boolean(s3.forcePathStyle) | |
| forcePathStyle: s3.forcePathStyle |
|
thanks! do you mind also updating the docs? https://github.com/transloadit/uppy.io |
The docs now live in uppy, not uppy.io |
aduh95
force-pushed
the
feature/s3-path-style
branch
from
0e2e84c
to
4b7f745
Compare
aduh95
reviewed
Jul 2, 2024
github-actions bot
added a commit
that referenced
this pull request
Jul 2, 2024
| Package | Version | Package | Version | | ---------------------- | ------- | ---------------------- | ------- | | @uppy/companion | 4.15.0 | @uppy/drag-drop | 3.1.1 | | @uppy/companion-client | 3.8.2 | @uppy/form | 3.2.2 | | @uppy/core | 3.13.1 | uppy | 3.27.2 | - @uppy/form: do not emit `'submit'` event more than once (Merlijn Vos / #5299) - @uppy/companion: add `s3.forcePathStyle` option (Nadeem Reinhardt / #5066) - meta: fix broken workflow status badges in README (Alexander Zaytsev / #5298) - @uppy/core: add `clearUploadedFiles` to type definition (Augustine Smith / #5295) - @uppy/companion: add `oauthOrigin` option (Antoine du Hamel / #5297) - meta: add dark-mode Transloadit logo in README (Alexander Zaytsev / #5291) - docs,@uppy/drag-drop: `uppy.io/docs` - fix typos/broken links (Evgenia Karunus / #5296) - meta: Bump docker/build-push-action from 6.1.0 to 6.2.0 (dependabot[bot] / #5290)
|
i believe this was merged prematurely |
mifi
added a commit
that referenced
this pull request
Jul 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds support for setting the S3 client's forcePathStyle option. That is necessary to use uppy/companion alongside localstack in development environments.
Subdomain based access to localstack S3 buckets is not supported and AWS has not announced a sunset date for path style access yet.
Alternatively, this is also possible via a Dockerfile, e.g: