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

companion-client: rename serverHeaders to companionHeaders #1861

Merged
merged 1 commit into from
Oct 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/@uppy/companion-client/src/RequestClient.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ module.exports = class RequestClient {
}

headers () {
return Promise.resolve(
Object.assign({}, this.defaultHeaders, this.opts.serverHeaders || {})
)
const userHeaders = this.opts.companionHeaders || this.opts.serverHeaders || {}
return Promise.resolve({
...this.defaultHeaders,
...userHeaders
})
}

_getPostResponseFunc (skip) {
Expand Down
4 changes: 4 additions & 0 deletions packages/@uppy/companion-client/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
export interface RequestClientOptions {
companionUrl: string;
companionHeaders?: object;
/**
* Deprecated, use `companionHeaders` instead.
*/
serverHeaders?: object;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/@uppy/dropbox/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ module.exports = class Dropbox extends Plugin {

this.provider = new Provider(uppy, {
companionUrl: this.opts.companionUrl,
serverHeaders: this.opts.serverHeaders,
companionHeaders: this.opts.companionHeaders || this.opts.serverHeaders,
storage: this.opts.storage,
provider: 'dropbox',
pluginId: this.id
Expand Down
2 changes: 1 addition & 1 deletion packages/@uppy/facebook/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ module.exports = class Facebook extends Plugin {

this.provider = new Provider(uppy, {
companionUrl: this.opts.companionUrl,
serverHeaders: this.opts.serverHeaders,
companionHeaders: this.opts.companionHeaders || this.opts.serverHeaders,
storage: this.opts.storage,
provider: 'facebook',
pluginId: this.id
Expand Down
2 changes: 1 addition & 1 deletion packages/@uppy/google-drive/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ module.exports = class GoogleDrive extends Plugin {

this.provider = new Provider(uppy, {
companionUrl: this.opts.companionUrl,
serverHeaders: this.opts.serverHeaders,
companionHeaders: this.opts.companionHeaders || this.opts.serverHeaders,
storage: this.opts.storage,
provider: 'drive',
authProvider: 'google',
Expand Down
2 changes: 1 addition & 1 deletion packages/@uppy/instagram/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ module.exports = class Instagram extends Plugin {

this.provider = new Provider(uppy, {
companionUrl: this.opts.companionUrl,
serverHeaders: this.opts.serverHeaders,
companionHeaders: this.opts.companionHeaders || this.opts.serverHeaders,
storage: this.opts.storage,
provider: 'instagram',
authProvider: 'instagram',
Expand Down
2 changes: 1 addition & 1 deletion packages/@uppy/onedrive/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ module.exports = class OneDrive extends Plugin {

this.provider = new Provider(uppy, {
companionUrl: this.opts.companionUrl,
serverHeaders: this.opts.serverHeaders,
companionHeaders: this.opts.companionHeaders || this.opts.serverHeaders,
storage: this.opts.storage,
provider: 'onedrive',
pluginId: this.id
Expand Down
1 change: 1 addition & 0 deletions packages/@uppy/robodog/src/addProviders.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const localProviders = {
const remoteProviderOptionNames = [
'companionUrl',
'companionAllowedHosts',
'companionHeaders',
'serverHeaders',
'target'
]
Expand Down
2 changes: 1 addition & 1 deletion packages/@uppy/url/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ module.exports = class Url extends Plugin {

this.client = new RequestClient(uppy, {
companionUrl: this.opts.companionUrl,
serverHeaders: this.opts.serverHeaders
companionHeaders: this.opts.companionHeaders || this.opts.serverHeaders
})
}

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/aws-s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ uppy.use(AwsS3, {
})
```

### `serverHeaders: {}`
### `companionHeaders: {}`

> Note: This only applies when using [Companion][companion docs] to sign S3 uploads.

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/dropbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ DOM element, CSS selector, or plugin to mount the Dropbox provider into. This sh

URL to a [Companion](/docs/companion) instance.

### `serverHeaders: {}`
### `companionHeaders: {}`

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

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/facebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ DOM element, CSS selector, or plugin to mount the Facebook provider into. This s

URL to a [Companion](/docs/companion) instance.

### `serverHeaders: {}`
### `companionHeaders: {}`

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

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/google-drive.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ DOM element, CSS selector, or plugin to mount the Google Drive provider into. Th

URL to a [Companion](/docs/companion) instance.

### `serverHeaders: {}`
### `companionHeaders: {}`

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

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/instagram.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ DOM element, CSS selector, or plugin to mount the Instagram provider into. This

URL to a [Companion](/docs/companion) instance.

### `serverHeaders: {}`
### `companionHeaders: {}`

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

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/onedrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ DOM element, CSS selector, or plugin to mount the OneDrive provider into. This s

URL to a [Companion](/docs/companion) instance.

### `serverHeaders: {}`
### `companionHeaders: {}`

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

Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/robodog-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ This value can be a `String`, a `Regex` pattern, or an `Array` of both.

This is useful when you have your [Uppy Companion][companion] running on multiple hosts. Otherwise, the default value should do just fine.

### `serverHeaders: {}`
### `companionHeaders: {}`

Custom headers to send to [Uppy Companion][companion].

Expand Down