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

@uppy/dashboard: auto discover and install plugins without target #4343

Merged
merged 18 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from 8 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
7 changes: 6 additions & 1 deletion e2e/clients/react/App.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@ import Uppy from '@uppy/core'
import React, { useState } from 'react'
import { Dashboard, DashboardModal, DragDrop } from '@uppy/react'
import ThumbnailGenerator from '@uppy/thumbnail-generator'
import RemoteSources from '@uppy/remote-sources'

import '@uppy/core/dist/style.css'
import '@uppy/dashboard/dist/style.css'
import '@uppy/drag-drop/dist/style.css'

export default function App () {
const uppyDashboard = new Uppy({ id: 'dashboard' })
const RemoteSourcesOptions = {
companionUrl: 'http://companion.uppy.io',
sources: ['GoogleDrive', 'OneDrive', 'Unsplash', 'Zoom', 'Url'],
}
const uppyDashboard = new Uppy({ id: 'dashboard' }).use(RemoteSources, { ...RemoteSourcesOptions })
const uppyModal = new Uppy({ id: 'modal' })
const uppyDragDrop = new Uppy({ id: 'drag-drop' }).use(ThumbnailGenerator)
const [open, setOpen] = useState(false)
Expand Down
10 changes: 10 additions & 0 deletions e2e/cypress/integration/react.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ describe('@uppy/react', () => {
.each((element) => expect(element).attr('src').to.include('blob:'))
})

it('should render Dashboard with Remote Sources plugin pack', () => {
const sources = ['My Device', 'Google Drive', 'OneDrive', 'Unsplash', 'Zoom', 'Link']
cy.get('#dashboard .uppy-DashboardTab-name')
.each((item, index, list) => {
expect(list).to.have.length(6)
// Returns the current element from the loop
expect(Cypress.$(item).text()).to.eq(sources[index])
})
})

it('should render Modal in React and show thumbnails', () => {
cy.get('#open').click()
cy.get('@modal-input').selectFile(['cypress/fixtures/images/cat.jpg', 'cypress/fixtures/images/traffic.jpg'], { force:true })
Expand Down
2 changes: 2 additions & 0 deletions packages/@uppy/core/src/Uppy.js
Original file line number Diff line number Diff line change
Expand Up @@ -1245,6 +1245,8 @@ class Uppy {
}
plugin.install()

this.emit('plugin-added', plugin)
arturi marked this conversation as resolved.
Show resolved Hide resolved

return this
}

Expand Down
41 changes: 27 additions & 14 deletions packages/@uppy/dashboard/src/Dashboard.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -749,6 +749,7 @@ export default class Dashboard extends UIPlugin {
this.startListeningToResize()
document.addEventListener('paste', this.handlePasteOnBody)

this.uppy.on('plugin-added', this.#autoDiscoverPlugins)
arturi marked this conversation as resolved.
Show resolved Hide resolved
this.uppy.on('plugin-remove', this.removeTarget)
this.uppy.on('file-added', this.hideAllPanels)
this.uppy.on('dashboard:modal-closed', this.hideAllPanels)
Expand Down Expand Up @@ -782,6 +783,7 @@ export default class Dashboard extends UIPlugin {
document.removeEventListener('paste', this.handlePasteOnBody)

window.removeEventListener('popstate', this.handlePopState, false)
this.uppy.off('plugin-added', this.#autoDiscoverPlugins)
this.uppy.off('plugin-remove', this.removeTarget)
this.uppy.off('file-added', this.hideAllPanels)
this.uppy.off('dashboard:modal-closed', this.hideAllPanels)
Expand Down Expand Up @@ -1015,10 +1017,29 @@ export default class Dashboard extends UIPlugin {
})
}

discoverProviderPlugins = () => {
this.uppy.iteratePlugins((plugin) => {
if (plugin && !plugin.target && plugin.opts && plugin.opts.target === this.constructor) {
this.addTarget(plugin)
#addSpecifiedPlugins = () => {
const plugins = this.opts.plugins || []

plugins.forEach((pluginID) => {
const plugin = this.uppy.getPlugin(pluginID)
if (plugin) {
plugin.mount(this, plugin)
} else {
this.uppy.log(`[Uppy] Dashboard could not find plugin '${pluginID}', make sure to uppy.use() the plugins you are specifying`, 'warning')
}
})
}

#autoDiscoverPlugins = () => {
// Only these types belong on the Dashboard,
// we wouldn’t want to try and mount Compressor or Tus, for example.
const typesAllowed = ['acquirer', 'editor']
arturi marked this conversation as resolved.
Show resolved Hide resolved
arturi marked this conversation as resolved.
Show resolved Hide resolved
this.uppy.iteratePlugins(plugin => {
if (plugin && !plugin.opts?.target && typesAllowed.includes(plugin.type)) {
const pluginAlreadyAdded = this.getPluginState().targets.some(
installedPlugin => plugin.id === installedPlugin.id,
)
if (!pluginAlreadyAdded) this.addTarget(plugin)
}
})
}
Expand Down Expand Up @@ -1055,15 +1076,6 @@ export default class Dashboard extends UIPlugin {
this.mount(target, this)
}

const plugins = this.opts.plugins || []

plugins.forEach((pluginID) => {
const plugin = this.uppy.getPlugin(pluginID)
if (plugin) {
plugin.mount(this, plugin)
}
})

if (!this.opts.disableStatusBar) {
this.uppy.use(StatusBar, {
id: `${this.id}:StatusBar`,
Expand Down Expand Up @@ -1111,7 +1123,8 @@ export default class Dashboard extends UIPlugin {
this.darkModeMediaQuery.addListener(this.handleSystemDarkModeChange)
}

this.discoverProviderPlugins()
this.#addSpecifiedPlugins()
this.#autoDiscoverPlugins()
arturi marked this conversation as resolved.
Show resolved Hide resolved
this.initEvents()
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ export default class ProviderView extends View {
// and that will allow the user to start the upload, so we need to make sure we have
// finished all async operations before we add any file
// see https://github.com/transloadit/uppy/pull/4384
this.plugin.uppy.log('Adding remote provider files')
this.plugin.uppy.log('Adding files from a remote provider')
this.plugin.uppy.addFiles(newFiles.map((file) => this.getTagFile(file)))

this.plugin.setPluginState({ filterInput: '' })
Expand Down
4 changes: 1 addition & 3 deletions packages/@uppy/remote-sources/src/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { BasePlugin } from '@uppy/core'
import Dashboard from '@uppy/dashboard'
import Dropbox from '@uppy/dropbox'
import GoogleDrive from '@uppy/google-drive'
import Instagram from '@uppy/instagram'
Expand Down Expand Up @@ -34,11 +33,10 @@ export default class RemoteSources extends BasePlugin {
constructor (uppy, opts) {
super(uppy, opts)
this.id = this.opts.id || 'RemoteSources'
this.type = 'acquirer'
this.type = 'preset'

const defaultOptions = {
sources: Object.keys(availablePlugins),
target: Dashboard,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a breaking change, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, for RemoteSources unfortunately. But not for the Dashboard. But if you update RemoteSources and not the Dashboard, it will stop working, true.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make that opt-in somehow? Maybe by adding an option ignoreTarget: true, and we would remove both options in the next major, wdyt?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hope we can figure out something without adding more options. Either by letting plugins do breaking changes whenever they want or by skipping this feature in remote sources for now.

}
this.opts = { ...defaultOptions, ...opts }

Expand Down