From f4e558bf9430b29bcc085731d5a6b5933656b68e Mon Sep 17 00:00:00 2001 From: Ifedapo Olarewaju Date: Sun, 14 Apr 2019 13:53:50 +0100 Subject: [PATCH] rename serverUrl to companionUrl and serverPattern to companionAllowedHosts --- packages/@uppy/aws-s3-multipart/README.md | 2 +- packages/@uppy/aws-s3-multipart/src/index.js | 6 +++--- packages/@uppy/aws-s3-multipart/types/index.d.ts | 2 +- packages/@uppy/aws-s3/README.md | 2 +- packages/@uppy/aws-s3/src/index.js | 4 ++-- packages/@uppy/aws-s3/types/index.d.ts | 2 +- packages/@uppy/companion-client/README.md | 4 ++-- packages/@uppy/companion-client/src/Provider.js | 16 ++++++++-------- .../@uppy/companion-client/src/RequestClient.js | 4 ++-- .../companion-client/src/RequestClient.test.js | 4 ++-- packages/@uppy/companion-client/types/index.d.ts | 2 +- packages/@uppy/dashboard/src/index.test.js | 4 ++-- packages/@uppy/dropbox/src/index.js | 2 +- packages/@uppy/dropbox/types/index.d.ts | 4 ++-- packages/@uppy/google-drive/src/index.js | 2 +- packages/@uppy/google-drive/types/index.d.ts | 4 ++-- packages/@uppy/instagram/src/index.js | 2 +- packages/@uppy/instagram/types/index.d.ts | 4 ++-- packages/@uppy/provider-views/src/index.js | 6 +++--- packages/@uppy/robodog/src/addProviders.js | 8 ++++---- packages/@uppy/transloadit/src/index.js | 10 +++++----- packages/@uppy/tus/src/index.js | 2 +- packages/@uppy/url/src/index.js | 6 +++--- packages/@uppy/url/types/index.d.ts | 2 +- packages/@uppy/xhr-upload/src/index.js | 2 +- 25 files changed, 53 insertions(+), 53 deletions(-) diff --git a/packages/@uppy/aws-s3-multipart/README.md b/packages/@uppy/aws-s3-multipart/README.md index 2a7e8a4ac..c338f8621 100644 --- a/packages/@uppy/aws-s3-multipart/README.md +++ b/packages/@uppy/aws-s3-multipart/README.md @@ -18,7 +18,7 @@ const AwsS3Multipart = require('@uppy/aws-s3-multipart') const uppy = Uppy() uppy.use(AwsS3Multipart, { limit: 2, - serverUrl: 'https://companion.myapp.com/' + companionUrl: 'https://companion.myapp.com/' }) ``` diff --git a/packages/@uppy/aws-s3-multipart/src/index.js b/packages/@uppy/aws-s3-multipart/src/index.js index 11937d327..9c49b94b3 100644 --- a/packages/@uppy/aws-s3-multipart/src/index.js +++ b/packages/@uppy/aws-s3-multipart/src/index.js @@ -86,8 +86,8 @@ module.exports = class AwsS3Multipart extends Plugin { } assertHost () { - if (!this.opts.serverUrl) { - throw new Error('Expected a `serverUrl` option containing a Companion address.') + if (!this.opts.companionUrl) { + throw new Error('Expected a `companionUrl` option containing a Companion address.') } } @@ -278,7 +278,7 @@ module.exports = class AwsS3Multipart extends Plugin { connectToServerSocket (file) { return new Promise((resolve, reject) => { const token = file.serverToken - const host = getSocketHost(file.remote.serverUrl) + const host = getSocketHost(file.remote.companionUrl) const socket = new Socket({ target: `${host}/api/${token}` }) this.uploaderSockets[socket] = socket this.uploaderEvents[file.id] = createEventTracker(this.uppy) diff --git a/packages/@uppy/aws-s3-multipart/types/index.d.ts b/packages/@uppy/aws-s3-multipart/types/index.d.ts index 0e3e2ade2..934140ce8 100644 --- a/packages/@uppy/aws-s3-multipart/types/index.d.ts +++ b/packages/@uppy/aws-s3-multipart/types/index.d.ts @@ -8,7 +8,7 @@ declare module AwsS3Multipart { } interface AwsS3MultipartOptions extends Uppy.PluginOptions { - serverUrl: string; + companionUrl: string; createMultipartUpload(file: Uppy.UppyFile): Promise<{ uploadId: string, key: string }>; listParts(file: Uppy.UppyFile, opts: { uploadId: string, key: string }): Promise; prepareUploadPart(file: Uppy.UppyFile, partData: { uploadId: string, key: string, body: Blob, number: number }): Promise<{ url: string }>; diff --git a/packages/@uppy/aws-s3/README.md b/packages/@uppy/aws-s3/README.md index e1bd2ef04..6e9a13ac7 100644 --- a/packages/@uppy/aws-s3/README.md +++ b/packages/@uppy/aws-s3/README.md @@ -19,7 +19,7 @@ const uppy = Uppy() uppy.use(AwsS3, { limit: 2, timeout: ms('1 minute'), - serverUrl: 'https://companion.myapp.com/' + companionUrl: 'https://companion.myapp.com/' }) ``` diff --git a/packages/@uppy/aws-s3/src/index.js b/packages/@uppy/aws-s3/src/index.js index e34fa4e8b..770f96025 100644 --- a/packages/@uppy/aws-s3/src/index.js +++ b/packages/@uppy/aws-s3/src/index.js @@ -66,8 +66,8 @@ module.exports = class AwsS3 extends Plugin { } getUploadParameters (file) { - if (!this.opts.serverUrl) { - throw new Error('Expected a `serverUrl` option containing a Companion address.') + if (!this.opts.companionUrl) { + throw new Error('Expected a `companionUrl` option containing a Companion address.') } const filename = encodeURIComponent(file.meta.name) diff --git a/packages/@uppy/aws-s3/types/index.d.ts b/packages/@uppy/aws-s3/types/index.d.ts index 26537e23e..62bf3a5f2 100644 --- a/packages/@uppy/aws-s3/types/index.d.ts +++ b/packages/@uppy/aws-s3/types/index.d.ts @@ -9,7 +9,7 @@ declare module AwsS3 { } interface AwsS3Options extends Uppy.PluginOptions { - serverUrl: string; + companionUrl: string; getUploadParameters(file: Uppy.UppyFile): Promise; timeout: number; limit: number; diff --git a/packages/@uppy/companion-client/README.md b/packages/@uppy/companion-client/README.md index 9821a40e9..30c350406 100644 --- a/packages/@uppy/companion-client/README.md +++ b/packages/@uppy/companion-client/README.md @@ -17,11 +17,11 @@ const { Provider, RequestClient, Socket } = require('@uppy/companion-client') const uppy = Uppy() -const client = new RequestClient(uppy, { serverUrl: 'https://uppy.mywebsite.com/' }) +const client = new RequestClient(uppy, { companionUrl: 'https://uppy.mywebsite.com/' }) client.get('/drive/list').then(() => {}) const provider = new Provider(uppy, { - serverUrl: 'https://uppy.mywebsite.com/', + companionUrl: 'https://uppy.mywebsite.com/', provider: providerPluginInstance }) provider.checkAuth().then(() => {}) diff --git a/packages/@uppy/companion-client/src/Provider.js b/packages/@uppy/companion-client/src/Provider.js index 069406be6..b4f491efa 100644 --- a/packages/@uppy/companion-client/src/Provider.js +++ b/packages/@uppy/companion-client/src/Provider.js @@ -74,19 +74,19 @@ module.exports = class Provider extends RequestClient { plugin.opts = Object.assign({}, defaultOpts, opts) } - if (opts.serverPattern) { - const pattern = opts.serverPattern - // validate serverPattern param + if (opts.companionAllowedHosts) { + const pattern = opts.companionAllowedHosts + // validate companionAllowedHosts param if (typeof pattern !== 'string' && !Array.isArray(pattern) && !(pattern instanceof RegExp)) { - throw new TypeError(`${plugin.id}: the option "serverPattern" must be one of string, Array, RegExp`) + throw new TypeError(`${plugin.id}: the option "companionAllowedHosts" must be one of string, Array, RegExp`) } - plugin.opts.serverPattern = pattern + plugin.opts.companionAllowedHosts = pattern } else { // does not start with https:// - if (/^(?!https?:\/\/).*$/i.test(opts.serverUrl)) { - plugin.opts.serverPattern = `https://${opts.serverUrl.replace(/^\/\//, '')}` + if (/^(?!https?:\/\/).*$/i.test(opts.companionUrl)) { + plugin.opts.companionAllowedHosts = `https://${opts.companionUrl.replace(/^\/\//, '')}` } else { - plugin.opts.serverPattern = opts.serverUrl + plugin.opts.companionAllowedHosts = opts.companionUrl } } diff --git a/packages/@uppy/companion-client/src/RequestClient.js b/packages/@uppy/companion-client/src/RequestClient.js index 743263af6..8a909c5ad 100644 --- a/packages/@uppy/companion-client/src/RequestClient.js +++ b/packages/@uppy/companion-client/src/RequestClient.js @@ -16,7 +16,7 @@ module.exports = class RequestClient { get hostname () { const { companion } = this.uppy.getState() - const host = this.opts.serverUrl + const host = this.opts.companionUrl return stripSlash(companion && companion[host] ? companion[host] : host) } @@ -44,7 +44,7 @@ module.exports = class RequestClient { onReceiveResponse (response) { const state = this.uppy.getState() const companion = state.companion || {} - const host = this.opts.serverUrl + const host = this.opts.companionUrl const headers = response.headers // Store the self-identified domain name for the Companion instance we just hit. if (headers.has('i-am') && headers.get('i-am') !== companion[host]) { diff --git a/packages/@uppy/companion-client/src/RequestClient.test.js b/packages/@uppy/companion-client/src/RequestClient.test.js index bde18d579..252dbef79 100644 --- a/packages/@uppy/companion-client/src/RequestClient.test.js +++ b/packages/@uppy/companion-client/src/RequestClient.test.js @@ -3,8 +3,8 @@ const RequestClient = require('./RequestClient') describe('RequestClient', () => { it('has a hostname without trailing slash', () => { const mockCore = { getState: () => ({}) } - const a = new RequestClient(mockCore, { serverUrl: 'http://companion.uppy.io' }) - const b = new RequestClient(mockCore, { serverUrl: 'http://companion.uppy.io/' }) + const a = new RequestClient(mockCore, { companionUrl: 'http://companion.uppy.io' }) + const b = new RequestClient(mockCore, { companionUrl: 'http://companion.uppy.io/' }) expect(a.hostname).toBe('http://companion.uppy.io') expect(b.hostname).toBe('http://companion.uppy.io') diff --git a/packages/@uppy/companion-client/types/index.d.ts b/packages/@uppy/companion-client/types/index.d.ts index e50b915f1..7d7610925 100644 --- a/packages/@uppy/companion-client/types/index.d.ts +++ b/packages/@uppy/companion-client/types/index.d.ts @@ -1,7 +1,7 @@ import Uppy = require('@uppy/core'); export interface RequestClientOptions { - serverUrl: string; + companionUrl: string; serverHeaders?: object; } diff --git a/packages/@uppy/dashboard/src/index.test.js b/packages/@uppy/dashboard/src/index.test.js index 76f07bafb..f9eee484f 100644 --- a/packages/@uppy/dashboard/src/index.test.js +++ b/packages/@uppy/dashboard/src/index.test.js @@ -35,7 +35,7 @@ describe('Dashboard', () => { inline: true, target: 'body' }) - core.use(GoogleDrivePlugin, { target: DashboardPlugin, serverUrl: 'https://fake.uppy.io/' }) + core.use(GoogleDrivePlugin, { target: DashboardPlugin, companionUrl: 'https://fake.uppy.io/' }) }).not.toThrow() core.close() @@ -43,7 +43,7 @@ describe('Dashboard', () => { it('works when passing plugins in `plugins` array', () => { const core = new Core() - core.use(GoogleDrivePlugin, { serverUrl: 'https://fake.uppy.io/' }) + core.use(GoogleDrivePlugin, { companionUrl: 'https://fake.uppy.io/' }) expect(() => { core.use(DashboardPlugin, { diff --git a/packages/@uppy/dropbox/src/index.js b/packages/@uppy/dropbox/src/index.js index c4beca20a..91b12f92b 100644 --- a/packages/@uppy/dropbox/src/index.js +++ b/packages/@uppy/dropbox/src/index.js @@ -16,7 +16,7 @@ module.exports = class Dropbox extends Plugin { ) this.provider = new Provider(uppy, { - serverUrl: this.opts.serverUrl, + companionUrl: this.opts.companionUrl, serverHeaders: this.opts.serverHeaders, storage: this.opts.storage, provider: 'dropbox', diff --git a/packages/@uppy/dropbox/types/index.d.ts b/packages/@uppy/dropbox/types/index.d.ts index 13ae73669..f40c2e6d1 100644 --- a/packages/@uppy/dropbox/types/index.d.ts +++ b/packages/@uppy/dropbox/types/index.d.ts @@ -3,8 +3,8 @@ import CompanionClient = require('@uppy/companion-client'); declare module Dropbox { interface DropboxOptions extends Uppy.PluginOptions, CompanionClient.ProviderOptions { - serverUrl: string; - serverPattern: string | RegExp | Array; + companionUrl: string; + companionAllowedHosts: string | RegExp | Array; } } diff --git a/packages/@uppy/google-drive/src/index.js b/packages/@uppy/google-drive/src/index.js index 3693ffcf9..365ce0f1b 100644 --- a/packages/@uppy/google-drive/src/index.js +++ b/packages/@uppy/google-drive/src/index.js @@ -21,7 +21,7 @@ module.exports = class GoogleDrive extends Plugin { ) this.provider = new Provider(uppy, { - serverUrl: this.opts.serverUrl, + companionUrl: this.opts.companionUrl, serverHeaders: this.opts.serverHeaders, storage: this.opts.storage, provider: 'drive', diff --git a/packages/@uppy/google-drive/types/index.d.ts b/packages/@uppy/google-drive/types/index.d.ts index fce0a8151..523ffd4f9 100644 --- a/packages/@uppy/google-drive/types/index.d.ts +++ b/packages/@uppy/google-drive/types/index.d.ts @@ -3,8 +3,8 @@ import CompanionClient = require('@uppy/companion-client'); declare module GoogleDrive { interface GoogleDriveOptions extends Uppy.PluginOptions, CompanionClient.ProviderOptions { - serverUrl: string; - serverPattern: string | RegExp | Array; + companionUrl: string; + companionAllowedHosts: string | RegExp | Array; } } diff --git a/packages/@uppy/instagram/src/index.js b/packages/@uppy/instagram/src/index.js index f0e2876d4..1b5e4ea25 100644 --- a/packages/@uppy/instagram/src/index.js +++ b/packages/@uppy/instagram/src/index.js @@ -18,7 +18,7 @@ module.exports = class Instagram extends Plugin { ) this.provider = new Provider(uppy, { - serverUrl: this.opts.serverUrl, + companionUrl: this.opts.companionUrl, serverHeaders: this.opts.serverHeaders, storage: this.opts.storage, provider: 'instagram', diff --git a/packages/@uppy/instagram/types/index.d.ts b/packages/@uppy/instagram/types/index.d.ts index 646288595..cd4a30e37 100644 --- a/packages/@uppy/instagram/types/index.d.ts +++ b/packages/@uppy/instagram/types/index.d.ts @@ -3,8 +3,8 @@ import CompanionClient = require('@uppy/companion-client'); declare module Instagram { interface InstagramOptions extends Uppy.PluginOptions, CompanionClient.ProviderOptions { - serverUrl: string; - serverPattern: string | RegExp | Array; + companionUrl: string; + companionAllowedHosts: string | RegExp | Array; } } diff --git a/packages/@uppy/provider-views/src/index.js b/packages/@uppy/provider-views/src/index.js index f5f26fdf1..6c1294363 100644 --- a/packages/@uppy/provider-views/src/index.js +++ b/packages/@uppy/provider-views/src/index.js @@ -153,7 +153,7 @@ module.exports = class ProviderView { fileId: file.id }, remote: { - serverUrl: this.plugin.opts.serverUrl, + companionUrl: this.plugin.opts.companionUrl, url: `${this.provider.fileUrl(file.requestPath)}`, body: { fileId: file.id @@ -423,8 +423,8 @@ module.exports = class ProviderView { const authWindow = window.open(link, '_blank') const handleToken = (e) => { - if (!this._isOriginAllowed(e.origin, this.plugin.opts.serverPattern) || e.source !== authWindow) { - this.plugin.uppy.log(`rejecting event from ${e.origin} vs allowed pattern ${this.plugin.opts.serverPattern}`) + if (!this._isOriginAllowed(e.origin, this.plugin.opts.companionAllowedHosts) || e.source !== authWindow) { + this.plugin.uppy.log(`rejecting event from ${e.origin} vs allowed pattern ${this.plugin.opts.companionAllowedHosts}`) return } authWindow.close() diff --git a/packages/@uppy/robodog/src/addProviders.js b/packages/@uppy/robodog/src/addProviders.js index 0c96bf6df..2d2c67468 100644 --- a/packages/@uppy/robodog/src/addProviders.js +++ b/packages/@uppy/robodog/src/addProviders.js @@ -12,8 +12,8 @@ const localProviders = { } const remoteProviderOptionNames = [ - 'serverUrl', - 'serverPattern', + 'companionUrl', + 'companionAllowedHosts', 'serverHeaders', 'target' ] @@ -27,8 +27,8 @@ function addRemoteProvider (uppy, name, opts) { const Provider = remoteProviders[name] const providerOptions = { // Default to the :tl: Companion servers. - serverUrl: Transloadit.COMPANION, - serverPattern: Transloadit.COMPANION_PATTERN + companionUrl: Transloadit.COMPANION, + companionAllowedHosts: Transloadit.COMPANION_PATTERN } remoteProviderOptionNames.forEach((name) => { diff --git a/packages/@uppy/transloadit/src/index.js b/packages/@uppy/transloadit/src/index.js index 4d53734aa..409aac9e9 100644 --- a/packages/@uppy/transloadit/src/index.js +++ b/packages/@uppy/transloadit/src/index.js @@ -113,10 +113,10 @@ module.exports = class Transloadit extends Plugin { // We only replace the hostname for Transloadit's companions, so that // people can also self-host them while still using Transloadit for encoding. let remote = file.remote - if (file.remote && TL_UPPY_SERVER.test(file.remote.serverUrl)) { + if (file.remote && TL_UPPY_SERVER.test(file.remote.companionUrl)) { const err = new Error( 'The https://api2.transloadit.com/uppy-server endpoint was renamed to ' + - 'https://api2.transloadit.com/companion, please update your `serverUrl` ' + + 'https://api2.transloadit.com/companion, please update your `companionUrl` ' + 'options accordingly.') // Explicitly log this error here because it is caught by the `createAssembly` // Promise further along. @@ -126,16 +126,16 @@ module.exports = class Transloadit extends Plugin { throw err } - if (file.remote && TL_COMPANION.test(file.remote.serverUrl)) { + if (file.remote && TL_COMPANION.test(file.remote.companionUrl)) { const newHost = status.companion_url .replace(/\/$/, '') const path = file.remote.url - .replace(file.remote.serverUrl, '') + .replace(file.remote.companionUrl, '') .replace(/^\//, '') remote = { ...file.remote, - serverUrl: newHost, + companionUrl: newHost, url: `${newHost}/${path}` } } diff --git a/packages/@uppy/tus/src/index.js b/packages/@uppy/tus/src/index.js index 969342ad8..bb2d547c1 100644 --- a/packages/@uppy/tus/src/index.js +++ b/packages/@uppy/tus/src/index.js @@ -271,7 +271,7 @@ module.exports = class Tus extends Plugin { connectToServerSocket (file) { return new Promise((resolve, reject) => { const token = file.serverToken - const host = getSocketHost(file.remote.serverUrl) + const host = getSocketHost(file.remote.companionUrl) const socket = new Socket({ target: `${host}/api/${token}` }) this.uploaderSockets[file.id] = socket this.uploaderEvents[file.id] = createEventTracker(this.uppy) diff --git a/packages/@uppy/url/src/index.js b/packages/@uppy/url/src/index.js index b012bb6a4..229aaa4cf 100644 --- a/packages/@uppy/url/src/index.js +++ b/packages/@uppy/url/src/index.js @@ -40,7 +40,7 @@ module.exports = class Url extends Plugin { this.i18n = this.translator.translate.bind(this.translator) this.i18nArray = this.translator.translateArray.bind(this.translator) - this.hostname = this.opts.serverUrl + this.hostname = this.opts.companionUrl if (!this.hostname) { throw new Error('Companion hostname is required, please consult https://uppy.io/docs/companion') @@ -56,7 +56,7 @@ module.exports = class Url extends Plugin { this.handlePaste = this.handlePaste.bind(this) this.client = new RequestClient(uppy, { - serverUrl: this.opts.serverUrl, + companionUrl: this.opts.companionUrl, serverHeaders: this.opts.serverHeaders }) } @@ -120,7 +120,7 @@ module.exports = class Url extends Plugin { url: url }, remote: { - serverUrl: this.opts.serverUrl, + companionUrl: this.opts.companionUrl, url: `${this.hostname}/url/get`, body: { fileId: url, diff --git a/packages/@uppy/url/types/index.d.ts b/packages/@uppy/url/types/index.d.ts index 66e540679..b67660196 100644 --- a/packages/@uppy/url/types/index.d.ts +++ b/packages/@uppy/url/types/index.d.ts @@ -2,7 +2,7 @@ import Uppy = require('@uppy/core'); declare module Url { export interface UrlOptions extends Uppy.PluginOptions { - serverUrl: string; + companionUrl: string; // TODO inherit from ProviderOptions } } diff --git a/packages/@uppy/xhr-upload/src/index.js b/packages/@uppy/xhr-upload/src/index.js index 474c0c8ec..32afcd3b1 100644 --- a/packages/@uppy/xhr-upload/src/index.js +++ b/packages/@uppy/xhr-upload/src/index.js @@ -333,7 +333,7 @@ module.exports = class XHRUpload extends Plugin { ) .then((res) => { const token = res.token - const host = getSocketHost(file.remote.serverUrl) + const host = getSocketHost(file.remote.companionUrl) const socket = new Socket({ target: `${host}/api/${token}` }) socket.on('progress', (progressData) => emitSocketProgress(this, progressData, file))