Skip to content

A platform for community discussion. Free, open, simple.

FIX: Stop uploaders from leaking destroyed components (#44802)

Jarek Radoszab47120404a9
diff --git a/frontend/discourse/admin/components/emoji-uploader.gjs b/frontend/discourse/admin/components/emoji-uploader.gjs
index 54e5736e5a2..21d80573cee 100644
--- a/frontend/discourse/admin/components/emoji-uploader.gjs
+++ b/frontend/discourse/admin/components/emoji-uploader.gjs
@@ -4,7 +4,6 @@ import { Input } from "@ember/component";
import { fn, hash } from "@ember/helper";
import { on } from "@ember/modifier";
import { action } from "@ember/object";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import { isEmpty } from "@ember/utils";
import withEventValue from "discourse/helpers/with-event-value";
@@ -24,7 +23,7 @@ export default class EmojiUploader extends Component {
/** @type {string[] | null} */
@resettableTracked newEmojiGroups = this.args.emojiGroups;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: "emoji-uploader",
type: "emoji",
uploadUrl: "/admin/config/emoji",
diff --git a/frontend/discourse/admin/components/images-uploader.gjs b/frontend/discourse/admin/components/images-uploader.gjs
index a9ba2de0792..0a9a8cd34d0 100644
--- a/frontend/discourse/admin/components/images-uploader.gjs
+++ b/frontend/discourse/admin/components/images-uploader.gjs
@@ -1,12 +1,11 @@
import Component from "@glimmer/component";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import UppyUpload from "discourse/lib/uppy/uppy-upload";
import dIcon from "discourse/ui-kit/helpers/d-icon";
import { i18n } from "discourse-i18n";
export default class ImagesUploader extends Component {
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: "images-uploader",
type: "avatar",
validateUploadedFilesOptions: {
diff --git a/frontend/discourse/admin/components/site-settings/upload.gjs b/frontend/discourse/admin/components/site-settings/upload.gjs
index 3a49c00a3c3..d7d97b63733 100644
--- a/frontend/discourse/admin/components/site-settings/upload.gjs
+++ b/frontend/discourse/admin/components/site-settings/upload.gjs
@@ -2,7 +2,6 @@ import Component from "@glimmer/component";
import { tracked } from "@glimmer/tracking";
import { on } from "@ember/modifier";
import { action } from "@ember/object";
-import { getOwner } from "@ember/owner";
import { service } from "@ember/service";
import { trustHTML } from "@ember/template";
import { modifier } from "ember-modifier";
@@ -87,7 +86,7 @@ export default class SiteSettingUpload extends Component {
/** @type {SiteSettingUploadedFile | null} */
@tracked uploadedFile = null;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: this.settingId,
type: "site_setting",
additionalParams: () => ({
diff --git a/frontend/discourse/admin/components/tags-uploader.gjs b/frontend/discourse/admin/components/tags-uploader.gjs
index d4830d3ad31..996d687c18b 100644
--- a/frontend/discourse/admin/components/tags-uploader.gjs
+++ b/frontend/discourse/admin/components/tags-uploader.gjs
@@ -1,6 +1,5 @@
import Component from "@glimmer/component";
import { action } from "@ember/object";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import { service } from "@ember/service";
import UppyUpload from "discourse/lib/uppy/uppy-upload";
@@ -11,7 +10,7 @@ import { i18n } from "discourse-i18n";
export default class TagsUploader extends Component {
@service dialog;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
type: "csv",
id: this.args.id,
uploadUrl: "/tags/upload",
diff --git a/frontend/discourse/admin/components/uppy-backup-uploader.gjs b/frontend/discourse/admin/components/uppy-backup-uploader.gjs
index 84bad07b1ec..a4aa9578ae5 100644
--- a/frontend/discourse/admin/components/uppy-backup-uploader.gjs
+++ b/frontend/discourse/admin/components/uppy-backup-uploader.gjs
@@ -1,5 +1,4 @@
import Component from "@glimmer/component";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import { service } from "@ember/service";
import UppyUpload from "discourse/lib/uppy/uppy-upload";
@@ -8,7 +7,7 @@ import { i18n } from "discourse-i18n";
export default class UppyBackupUploader extends Component {
@service siteSettings;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: "uppy-backup-uploader",
type: "backup",
uploadRootPath: "/admin/backups",
@@ -24,6 +23,9 @@ export default class UppyBackupUploader extends Component {
validateUploadedFilesOptions: { skipValidation: true },
+ // Leaving the tab must not abort a backup upload
+ finishUploadsOnDestroy: true,
+
uploadDone: (responseData) => {
this.args.done(responseData.file_name);
},
diff --git a/frontend/discourse/admin/components/watched-word-uploader.gjs b/frontend/discourse/admin/components/watched-word-uploader.gjs
index 50985a7c9ab..ca7bead878a 100644
--- a/frontend/discourse/admin/components/watched-word-uploader.gjs
+++ b/frontend/discourse/admin/components/watched-word-uploader.gjs
@@ -1,5 +1,4 @@
import Component from "@glimmer/component";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import { service } from "@ember/service";
import UppyUpload from "discourse/lib/uppy/uppy-upload";
@@ -9,7 +8,7 @@ import { i18n } from "discourse-i18n";
export default class WatchedWordUploader extends Component {
@service dialog;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: "watched-word-uploader",
type: "txt",
uploadUrl: "/admin/customize/watched_words/upload",
diff --git a/frontend/discourse/app/components/avatar-uploader.gjs b/frontend/discourse/app/components/avatar-uploader.gjs
index 7bc799080cb..ae05bd25854 100644
--- a/frontend/discourse/app/components/avatar-uploader.gjs
+++ b/frontend/discourse/app/components/avatar-uploader.gjs
@@ -1,7 +1,6 @@
/* eslint-disable ember/no-classic-components */
import Component from "@ember/component";
import { action, computed } from "@ember/object";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import { isBlank } from "@ember/utils";
import { tagName } from "@ember-decorators/component";
@@ -11,7 +10,7 @@ import { i18n } from "discourse-i18n";
@tagName("")
export default class AvatarUploader extends Component {
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: "avatar-uploader",
type: "avatar",
validateUploadedFilesOptions: {
diff --git a/frontend/discourse/app/components/composer-editor.gjs b/frontend/discourse/app/components/composer-editor.gjs
index 97bc31cfb5d..4622a61e885 100644
--- a/frontend/discourse/app/components/composer-editor.gjs
+++ b/frontend/discourse/app/components/composer-editor.gjs
@@ -3,7 +3,6 @@ import { tracked } from "@glimmer/tracking";
import Component from "@ember/component";
import { hash } from "@ember/helper";
import EmberObject, { action, computed } from "@ember/object";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import willDestroy from "@ember/render-modifiers/modifiers/will-destroy";
import { schedule, throttle } from "@ember/runloop";
@@ -117,7 +116,7 @@ export default class ComposerEditor extends Component {
this.warnedCannotSeeMentions = [];
this.warnedGroupMentions = [];
- this.uppyComposerUpload = new UppyComposerUpload(getOwner(this), {
+ this.uppyComposerUpload = new UppyComposerUpload(this, {
composerEventPrefix: this.composerEventPrefix,
composerModel: this.composer.model,
uploadMarkdownResolvers,
@@ -311,11 +310,6 @@ export default class ComposerEditor extends Component {
});
}
- willDestroyElement() {
- super.willDestroyElement(...arguments);
- this.uppyComposerUpload.teardown();
- }
-
@observes("composer.focusTarget")
setFocus() {
if (this.composer.focusTarget === "editor") {
diff --git a/frontend/discourse/app/components/create-invite-uploader.gjs b/frontend/discourse/app/components/create-invite-uploader.gjs
index 20f1ea783ae..cb96bba061a 100644
--- a/frontend/discourse/app/components/create-invite-uploader.gjs
+++ b/frontend/discourse/app/components/create-invite-uploader.gjs
@@ -2,13 +2,12 @@ import Component from "@glimmer/component";
import { tracked } from "@glimmer/tracking";
import { hash } from "@ember/helper";
import { action } from "@ember/object";
-import { getOwner } from "@ember/owner";
import UppyUpload from "discourse/lib/uppy/uppy-upload";
export default class CreateInviteUploader extends Component {
@tracked uploaded = false;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: "create-invite-uploader",
type: "csv",
autoStartUploads: false,
diff --git a/frontend/discourse/app/components/docked-composer.gjs b/frontend/discourse/app/components/docked-composer.gjs
index daf0521d5b2..1e03e6a95cb 100644
--- a/frontend/discourse/app/components/docked-composer.gjs
+++ b/frontend/discourse/app/components/docked-composer.gjs
@@ -1,9 +1,9 @@
import Component from "@glimmer/component";
import { tracked } from "@glimmer/tracking";
+import { destroy } from "@ember/destroyable";
import { fn, hash } from "@ember/helper";
import { action } from "@ember/object";
import { guidFor } from "@ember/object/internals";
-import { getOwner } from "@ember/owner";
import { trackedArray } from "@ember/reactive/collections";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import didUpdate from "@ember/render-modifiers/modifiers/did-update";
@@ -238,7 +238,7 @@ export default class DockedComposer extends Component {
this.args.onRegisterApi?.({ setReply: this.setReply, focus: this.focus });
this.loadDraft();
- this.uppyUpload = new UppyUpload(getOwner(this), {
+ this.uppyUpload = new UppyUpload(this, {
id: this.uploaderId,
type: this.uploadType,
useMultipartUploadsIfAvailable: true,
@@ -269,7 +269,10 @@ export default class DockedComposer extends Component {
true
);
this.inputElement?.removeEventListener("paste", this.#handlePaste);
- this.uppyUpload?.teardown();
+ if (this.uppyUpload) {
+ destroy(this.uppyUpload);
+ this.uppyUpload = null;
+ }
this.#rootElement = null;
}
diff --git a/frontend/discourse/app/components/form-template-field/upload.gjs b/frontend/discourse/app/components/form-template-field/upload.gjs
index b386a97f985..a69260492d4 100644
--- a/frontend/discourse/app/components/form-template-field/upload.gjs
+++ b/frontend/discourse/app/components/form-template-field/upload.gjs
@@ -1,6 +1,5 @@
import Component from "@glimmer/component";
import { action } from "@ember/object";
-import { getOwner } from "@ember/owner";
import { next, schedule } from "@ember/runloop";
import { service } from "@ember/service";
import { dasherize } from "@ember/string";
@@ -22,7 +21,7 @@ export default class FormTemplateFieldUpload extends Component {
@autoTrackedArray uploadedFiles = [];
fileUploadElementId = `${dasherize(this.args.id.toString())}-uploader`;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: this.args.id,
type: "composer",
uploadDone: this.uploadDone,
diff --git a/frontend/discourse/app/components/uppy-image-uploader.gjs b/frontend/discourse/app/components/uppy-image-uploader.gjs
index 2c336845ab8..4ae89036705 100644
--- a/frontend/discourse/app/components/uppy-image-uploader.gjs
+++ b/frontend/discourse/app/components/uppy-image-uploader.gjs
@@ -3,7 +3,6 @@ import { tracked } from "@glimmer/tracking";
import { on } from "@ember/modifier";
import { action } from "@ember/object";
import { guidFor } from "@ember/object/internals";
-import { getOwner } from "@ember/owner";
import { service } from "@ember/service";
import { trustHTML } from "@ember/template";
import { isEmpty } from "@ember/utils";
@@ -28,7 +27,7 @@ export default class UppyImageUploader extends Component {
@tracked imageWidth;
@tracked imageHeight;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: this.args.id,
type: this.args.type,
additionalParams: this.args.additionalParams,
diff --git a/frontend/discourse/app/lib/composer-video-thumbnail-uppy.js b/frontend/discourse/app/lib/composer-video-thumbnail-uppy.js
index e815eed5ae2..f080aa1c31e 100644
--- a/frontend/discourse/app/lib/composer-video-thumbnail-uppy.js
+++ b/frontend/discourse/app/lib/composer-video-thumbnail-uppy.js
@@ -1,6 +1,8 @@
import { tracked } from "@glimmer/tracking";
import { warn } from "@ember/debug";
-import { getOwner, setOwner } from "@ember/owner";
+import { destroy } from "@ember/destroyable";
+import { setOwner } from "@ember/owner";
+import { next } from "@ember/runloop";
import { service } from "@ember/service";
import { isVideo } from "discourse/lib/uploads";
import UppyUpload from "discourse/lib/uppy/uppy-upload";
@@ -42,6 +44,12 @@ export default class ComposerVideoThumbnailUppy {
// Clean up object URL when done
const cleanup = () => {
URL.revokeObjectURL(objectUrl);
+ // Deferred because this can run inside one of Uppy's own event handlers
+ next(() => {
+ if (this._uppyUpload) {
+ destroy(this._uppyUpload);
+ }
+ });
};
// These attributes are needed for thumbnail generation on mobile.
@@ -118,7 +126,7 @@ export default class ComposerVideoThumbnailUppy {
}
try {
- this._uppyUpload = new UppyUpload(getOwner(this), {
+ this._uppyUpload = new UppyUpload(this, {
id: "video-thumbnail",
type: "thumbnail",
useMultipartUploadsIfAvailable: true,
diff --git a/frontend/discourse/app/lib/uppy/composer-upload.js b/frontend/discourse/app/lib/uppy/composer-upload.js
index 8d522220ec9..21fe8294e35 100644
--- a/frontend/discourse/app/lib/uppy/composer-upload.js
+++ b/frontend/discourse/app/lib/uppy/composer-upload.js
@@ -1,4 +1,9 @@
+import ApplicationInstance from "@ember/application/instance";
import { warn } from "@ember/debug";
+import {
+ associateDestroyableChild,
+ registerDestructor,
+} from "@ember/destroyable";
import EmberObject from "@ember/object";
import { getOwner, setOwner } from "@ember/owner";
import { run } from "@ember/runloop";
@@ -10,6 +15,7 @@ import { cacheShortUploadUrl } from "pretty-text/upload-short-url";
import { updateCsrfToken } from "discourse/lib/ajax";
import ComposerVideoThumbnailUppy from "discourse/lib/composer-video-thumbnail-uppy";
import { bind } from "discourse/lib/decorators";
+import deprecated from "discourse/lib/deprecated";
import getURL from "discourse/lib/get-url";
import {
bindFileInputChangeListener,
@@ -64,8 +70,12 @@ export default class UppyComposerUpload {
#fileInputEl;
#editorEl;
+ /**
+ * @param {object} parent The component (or other destroyable) using this upload. It's torn down when the parent is destroyed.
+ * @param {object} options
+ */
constructor(
- owner,
+ parent,
{
composerEventPrefix,
composerModel,
@@ -75,8 +85,20 @@ export default class UppyComposerUpload {
fileUploadElementId,
}
) {
- setOwner(this, owner);
- this.uppyWrapper = new UppyWrapper(owner);
+ if (parent instanceof ApplicationInstance) {
+ deprecated(
+ "Passing an owner to `new UppyComposerUpload()` is deprecated. Pass the component that uses it instead, so it's torn down with that component.",
+ { id: "discourse.uppy-composer-upload-owner", since: "2026.10.0" }
+ );
+ setOwner(this, parent);
+ } else {
+ setOwner(this, getOwner(parent));
+ }
+
+ associateDestroyableChild(parent, this);
+ registerDestructor(this, () => this.teardown());
+
+ this.uppyWrapper = new UppyWrapper(getOwner(this));
this.composerEventPrefix = composerEventPrefix;
this.composerModel = composerModel;
this.uploadMarkdownResolvers = uploadMarkdownResolvers;
@@ -265,9 +287,6 @@ export default class UppyComposerUpload {
this.uppyWrapper.uppyInstance.on("upload-progress", (file, progress) => {
run(() => {
- if (this.isDestroying) {
- return;
- }
const upload = this.#inProgressUploads.find(
(upl) => upl.id === file.id
);
diff --git a/frontend/discourse/app/lib/uppy/uppy-upload.js b/frontend/discourse/app/lib/uppy/uppy-upload.js
index 9766edc7f7c..1c5780ad51e 100644
--- a/frontend/discourse/app/lib/uppy/uppy-upload.js
+++ b/frontend/discourse/app/lib/uppy/uppy-upload.js
@@ -1,9 +1,15 @@
import { tracked } from "@glimmer/tracking";
+import ApplicationInstance from "@ember/application/instance";
import { warn } from "@ember/debug";
+import {
+ associateDestroyableChild,
+ isDestroying,
+ registerDestructor,
+} from "@ember/destroyable";
import EmberObject from "@ember/object";
import { getOwner, setOwner } from "@ember/owner";
import { trackedArray } from "@ember/reactive/collections";
-import { run } from "@ember/runloop";
+import { next, run } from "@ember/runloop";
import { service } from "@ember/service";
import AwsS3 from "@uppy/aws-s3";
import Uppy from "@uppy/core";
@@ -11,6 +17,7 @@ import DropTarget from "@uppy/drop-target";
import XHRUpload from "@uppy/xhr-upload";
import { ajax, updateCsrfToken } from "discourse/lib/ajax";
import { bind } from "discourse/lib/decorators";
+import deprecated from "discourse/lib/deprecated";
import getUrl from "discourse/lib/get-url";
import { deepMerge } from "discourse/lib/object";
import {
@@ -32,6 +39,8 @@ const DEFAULT_CONFIG = {
uploadDone: null,
uploadError: null,
autoStartUploads: true,
+ /** let uploads in progress finish after the parent is destroyed */
+ finishUploadsOnDestroy: false,
uploadUrl: null,
uploadRootPath: "/uploads",
validateUploadedFilesOptions: {},
@@ -111,9 +120,35 @@ export default class UppyUpload {
_fileInputEl;
- constructor(owner, config) {
- setOwner(this, owner);
- this.uppyWrapper = new UppyWrapper(owner);
+ /**
+ * @param {object} parent The component (or other destroyable) using this upload. It's torn down when the parent is destroyed.
+ * @param {object} config
+ */
+ constructor(parent, config) {
+ if (parent instanceof ApplicationInstance) {
+ deprecated(
+ "Passing an owner to `new UppyUpload()` is deprecated. Pass the component that uses it instead, so it's torn down with that component.",
+ { id: "discourse.uppy-upload-owner", since: "2026.10.0" }
+ );
+ setOwner(this, parent);
+ } else {
+ setOwner(this, getOwner(parent));
+ }
+
+ associateDestroyableChild(parent, this);
+ registerDestructor(this, () => {
+ // With uploads in progress, #reset() tears down once they finish
+ if (
+ this.config.finishUploadsOnDestroy &&
+ (this.uploading || this.processing)
+ ) {
+ return;
+ }
+
+ this.teardown();
+ });
+
+ this.uppyWrapper = new UppyWrapper(getOwner(this));
this.config = lazyMergeConfig(config);
validateConfig(this.config);
}
@@ -135,8 +170,6 @@ export default class UppyUpload {
}
teardown() {
- this.messageBus.unsubscribe(`/uploads/${this.config.type}`);
-
this._fileInputEl?.removeEventListener(
"change",
this.#fileInputEventListener
@@ -151,11 +184,14 @@ export default class UppyUpload {
this.cancelSingleUpload
);
this.uppyWrapper.uppyInstance.destroy();
+ this.uppyWrapper.uppyInstance = null;
}
}
@bind
setup(fileInputEl) {
+ this.teardown();
+
if (fileInputEl) {
this._fileInputEl = fileInputEl;
this.allowMultipleFiles = this._fileInputEl.multiple;
@@ -499,7 +535,7 @@ export default class UppyUpload {
data,
})
.then((response) => {
- this.uppyWrapper.uppyInstance.setFileMeta(file.id, {
+ this.uppyWrapper.uppyInstance?.setFileMeta(file.id, {
uniqueUploadIdentifier: response.unique_identifier,
});
@@ -568,6 +604,11 @@ export default class UppyUpload {
if (this._fileInputEl) {
this._fileInputEl.value = "";
}
+
+ if (this.config.finishUploadsOnDestroy && isDestroying(this)) {
+ // Deferred because this can run inside one of Uppy's own event handlers
+ next(this, this.teardown);
+ }
}
#removeInProgressUpload(fileId) {
@@ -580,10 +621,6 @@ export default class UppyUpload {
}
#allUploadsComplete() {
- if (this.isDestroying) {
- return;
- }
-
this.appEvents.trigger(
`upload-mixin:${this.config.id}:all-uploads-complete`
);
diff --git a/frontend/discourse/tests/unit/lib/uppy/composer-upload-test.js b/frontend/discourse/tests/unit/lib/uppy/composer-upload-test.js
index 23fe07463e1..10509b5f8db 100644
--- a/frontend/discourse/tests/unit/lib/uppy/composer-upload-test.js
+++ b/frontend/discourse/tests/unit/lib/uppy/composer-upload-test.js
@@ -1,7 +1,10 @@
-import { getOwner } from "@ember/owner";
+import { destroy } from "@ember/destroyable";
+import { getOwner, setOwner } from "@ember/owner";
+import { run } from "@ember/runloop";
import { setupTest } from "ember-qunit";
import { module, test } from "qunit";
import sinon from "sinon";
+import { withSilencedDeprecations } from "discourse/lib/deprecated";
import UppyComposerUpload from "discourse/lib/uppy/composer-upload";
import { createFile } from "discourse/tests/helpers/qunit-helpers";
@@ -9,8 +12,8 @@ function fakeComposerModel() {
return { privateMessage: false };
}
-function buildUploader(context) {
- return new UppyComposerUpload(getOwner(context), {
+function buildUploader(parent) {
+ return new UppyComposerUpload(parent, {
composerEventPrefix: "composer",
composerModel: fakeComposerModel(),
uploadMarkdownResolvers: [],
@@ -46,16 +49,20 @@ module("Unit | Lib | uppy/composer-upload", function (hooks) {
this.editorInput.className = "d-editor-input";
this.formEl.appendChild(this.editorInput);
document.body.appendChild(this.formEl);
+
+ this.parent = {};
+ setOwner(this.parent, getOwner(this));
});
hooks.afterEach(function () {
+ run(() => destroy(this.parent));
this.fileInput.remove();
this.formEl.remove();
sinon.restore();
});
test("_pasteEventListener accepts paste from descendants of .d-editor-input", function (assert) {
- const uploader = buildUploader(this);
+ const uploader = buildUploader(this.parent);
uploader.uppyWrapper.uppyInstance = { addFiles: sinon.spy() };
const nested = document.createElement("span");
@@ -77,7 +84,7 @@ module("Unit | Lib | uppy/composer-upload", function (hooks) {
document.body.insertBefore(earlierInput, this.formEl);
try {
- const uploader = buildUploader(this);
+ const uploader = buildUploader(this.parent);
uploader.uppyWrapper.uppyInstance = { addFiles: sinon.spy() };
const file = createFile("paste.png", "image/png", "data");
@@ -94,7 +101,7 @@ module("Unit | Lib | uppy/composer-upload", function (hooks) {
});
test("_pasteEventListener ignores paste outside .d-editor-input", function (assert) {
- const uploader = buildUploader(this);
+ const uploader = buildUploader(this.parent);
uploader.uppyWrapper.uppyInstance = { addFiles: sinon.spy() };
const outside = document.createElement("div");
@@ -113,7 +120,7 @@ module("Unit | Lib | uppy/composer-upload", function (hooks) {
});
test("setup() called twice tears down the first binding", function (assert) {
- const uploader = buildUploader(this);
+ const uploader = buildUploader(this.parent);
uploader.setup(this.formEl);
const firstUppy = uploader.uppyWrapper.uppyInstance;
@@ -133,7 +140,39 @@ module("Unit | Lib | uppy/composer-upload", function (hooks) {
uploader.uppyWrapper.uppyInstance,
"second setup replaces the Uppy instance"
);
+ });
+
+ test("destroying the parent tears down", function (assert) {
+ const uploader = buildUploader(this.parent);
+ uploader.setup(this.formEl);
+ const uppyDestroy = sinon.spy(uploader.uppyWrapper.uppyInstance, "destroy");
+
+ run(() => destroy(this.parent));
+
+ assert.true(uppyDestroy.calledOnce, "destroys the Uppy instance");
+ });
+
+ test("teardown can run more than once", function (assert) {
+ const uploader = buildUploader(this.parent);
+ uploader.setup(this.formEl);
uploader.teardown();
+ uploader.teardown();
+
+ assert.strictEqual(
+ uploader.uppyWrapper.uppyInstance,
+ null,
+ "leaves no Uppy instance"
+ );
+ });
+
+ test("still accepts an owner", function (assert) {
+ const owner = getOwner(this);
+ const uploader = withSilencedDeprecations(
+ "discourse.uppy-composer-upload-owner",
+ () => buildUploader(owner)
+ );
+
+ assert.strictEqual(getOwner(uploader), owner, "uses it as the owner");
});
});
diff --git a/frontend/discourse/tests/unit/lib/uppy/uppy-upload-test.js b/frontend/discourse/tests/unit/lib/uppy/uppy-upload-test.js
index 7bbc20a2170..03c3c3c86af 100644
--- a/frontend/discourse/tests/unit/lib/uppy/uppy-upload-test.js
+++ b/frontend/discourse/tests/unit/lib/uppy/uppy-upload-test.js
@@ -1,8 +1,11 @@
-import { getOwner } from "@ember/owner";
+import { destroy } from "@ember/destroyable";
+import { getOwner, setOwner } from "@ember/owner";
+import { run } from "@ember/runloop";
import { waitUntil } from "@ember/test-helpers";
import { setupTest } from "ember-qunit";
import { module, test } from "qunit";
import sinon from "sinon";
+import { withSilencedDeprecations } from "discourse/lib/deprecated";
import { dialog } from "discourse/lib/uploads";
import UppyUpload from "discourse/lib/uppy/uppy-upload";
import pretender from "discourse/tests/helpers/create-pretender";
@@ -40,9 +43,13 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
this.fileInput.type = "file";
this.fileInput.multiple = true;
document.body.appendChild(this.fileInput);
+
+ this.parent = {};
+ setOwner(this.parent, getOwner(this));
});
hooks.afterEach(function () {
+ run(() => destroy(this.parent));
this.fileInput.remove();
sinon.restore();
});
@@ -67,7 +74,7 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
return uploadResponse(fileName);
});
- const upload = new UppyUpload(getOwner(this), {
+ const upload = new UppyUpload(this.parent, {
id: "uppy-upload-test",
type: "composer",
uploadDone: ({ file_name }) => completed.push(file_name),
@@ -96,8 +103,6 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
alert.calledOnceWith("upload failed"),
"the rejection is reported once, with the server's own message"
);
-
- upload.teardown();
});
test("a successful upload is not reported as cancelled", async function (assert) {
@@ -108,7 +113,7 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
uploadResponse(request.requestBody.get("file").name)
);
- const upload = new UppyUpload(getOwner(this), {
+ const upload = new UppyUpload(this.parent, {
id: "uppy-upload-success-test",
type: "composer",
uploadDone: ({ file_name }) => completed.push(file_name),
@@ -138,13 +143,11 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
[],
"the finished upload is not reported as cancelled"
);
-
- upload.teardown();
});
test("explicit single-file cancellation is reported", async function (assert) {
const cancellations = [];
- const upload = new UppyUpload(getOwner(this), {
+ const upload = new UppyUpload(this.parent, {
id: "uppy-upload-cancel-single-test",
type: "composer",
autoStartUploads: false,
@@ -173,13 +176,11 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
[],
"the cancelled file is removed"
);
-
- upload.teardown();
});
test("explicit cancel all is reported as cancelled", async function (assert) {
const cancellations = [];
- const upload = new UppyUpload(getOwner(this), {
+ const upload = new UppyUpload(this.parent, {
id: "uppy-upload-cancel-all-test",
type: "composer",
autoStartUploads: false,
@@ -201,8 +202,6 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
["uploads-cancelled"],
"explicit cancel all reports one cancellation"
);
-
- upload.teardown();
});
test("a batch drained by a cancel still reports the failure", async function (assert) {
@@ -218,7 +217,7 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
await new Promise(() => {});
});
- const upload = new UppyUpload(getOwner(this), {
+ const upload = new UppyUpload(this.parent, {
id: "uppy-upload-cancel-test",
type: "composer",
uploadDone: () => {},
@@ -243,7 +242,121 @@ module("Unit | Lib | uppy/uppy-upload", function (hooks) {
alert.calledOnceWith("upload failed"),
"the buffered failure is reported once the cancel drains the batch"
);
+ });
+
+ test("teardown destroys the Uppy instance", function (assert) {
+ const upload = new UppyUpload(this.parent, {
+ id: "uppy-upload-teardown-test",
+ type: "composer",
+ uploadDone: () => {},
+ });
+
+ upload.setup(this.fileInput);
+ const uppyDestroy = sinon.spy(upload.uppyWrapper.uppyInstance, "destroy");
+ upload.teardown();
+
+ assert.true(uppyDestroy.calledOnce, "destroys the instance");
+ });
+
+ test("destroying the parent tears down", function (assert) {
+ const upload = new UppyUpload(this.parent, {
+ id: "uppy-upload-parent-test",
+ type: "composer",
+ uploadDone: () => {},
+ });
+
+ upload.setup(this.fileInput);
+ const uppyDestroy = sinon.spy(upload.uppyWrapper.uppyInstance, "destroy");
+ run(() => destroy(this.parent));
+
+ assert.true(uppyDestroy.calledOnce, "destroys the Uppy instance");
+ });
+
+ test("still accepts an owner", function (assert) {
+ const owner = getOwner(this);
+ const upload = withSilencedDeprecations(
+ "discourse.uppy-upload-owner",
+ () =>
+ new UppyUpload(owner, {
+ id: "uppy-upload-owner-test",
+ type: "composer",
+ uploadDone: () => {},
+ })
+ );
+
+ upload.setup(this.fileInput);
+
+ assert.strictEqual(getOwner(upload), owner, "uses it as the owner");
+ });
+
+ test("finishUploadsOnDestroy lets an upload in progress finish", async function (assert) {
+ const completed = [];
+ let requested = false;
+ let respond;
+ const responded = new Promise((resolve) => (respond = resolve));
+
+ pretender.post(UPLOAD_URL, async (request) => {
+ requested = true;
+ await responded;
+ return uploadResponse(request.requestBody.get("file").name);
+ });
+
+ const upload = new UppyUpload(this.parent, {
+ id: "uppy-upload-finish-test",
+ type: "composer",
+ finishUploadsOnDestroy: true,
+ uploadDone: ({ file_name }) => completed.push(file_name),
+ });
+
+ upload.setup(this.fileInput);
+ const uppyDestroy = sinon.spy(upload.uppyWrapper.uppyInstance, "destroy");
+
+ await upload.addFiles([createFile(SIBLING_FILE)]);
+ await waitUntil(() => requested, { timeout: 5000 });
+ run(() => destroy(this.parent));
+
+ assert.false(uppyDestroy.called, "keeps the upload going");
+
+ respond();
+ await waitUntil(() => uppyDestroy.called, { timeout: 5000 });
+
+ assert.deepEqual(completed, [SIBLING_FILE], "finishes the upload");
+ assert.true(uppyDestroy.calledOnce, "tears down once idle");
+ });
+
+ test("teardown is a no-op before setup", function (assert) {
+ const unsubscribe = sinon.spy(
+ getOwner(this).lookup("service:message-bus"),
+ "unsubscribe"
+ );
+ const upload = new UppyUpload(this.parent, {
+ id: "uppy-upload-early-teardown-test",
+ type: "composer",
+ uploadDone: () => {},
+ });
upload.teardown();
+
+ assert.false(unsubscribe.called, "doesn't unsubscribe from MessageBus");
+ });
+
+ test("setup destroys the previous Uppy instance", function (assert) {
+ const upload = new UppyUpload(this.parent, {
+ id: "uppy-upload-setup-again-test",
+ type: "composer",
+ uploadDone: () => {},
+ });
+
+ upload.setup(this.fileInput);
+ const previous = upload.uppyWrapper.uppyInstance;
+ const uppyDestroy = sinon.spy(previous, "destroy");
+ upload.setup(this.fileInput);
+
+ assert.true(uppyDestroy.calledOnce, "destroys the previous instance");
+ assert.notStrictEqual(
+ upload.uppyWrapper.uppyInstance,
+ previous,
+ "creates a new instance"
+ );
});
});
diff --git a/plugins/chat/assets/javascripts/discourse/components/chat-composer-uploads.gjs b/plugins/chat/assets/javascripts/discourse/components/chat-composer-uploads.gjs
index e315ca2c077..41f5e4d4c1e 100644
--- a/plugins/chat/assets/javascripts/discourse/components/chat-composer-uploads.gjs
+++ b/plugins/chat/assets/javascripts/discourse/components/chat-composer-uploads.gjs
@@ -2,7 +2,6 @@
import Component from "@ember/component";
import { fn } from "@ember/helper";
import { action } from "@ember/object";
-import { getOwner } from "@ember/owner";
import { service } from "@ember/service";
import { tagName } from "@ember-decorators/component";
import { removeValueFromArray } from "discourse/lib/array-tools";
@@ -22,7 +21,7 @@ export default class ChatComposerUploads extends Component {
@autoTrackedArray uploads = null;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: "chat-composer-uploader",
type: "chat-composer",
useMultipartUploadsIfAvailable: true,
diff --git a/plugins/discourse-ai/assets/javascripts/discourse/components/ai-bot-conversations.gjs b/plugins/discourse-ai/assets/javascripts/discourse/components/ai-bot-conversations.gjs
index b1d7d56ccc4..7516dedff7c 100644
--- a/plugins/discourse-ai/assets/javascripts/discourse/components/ai-bot-conversations.gjs
+++ b/plugins/discourse-ai/assets/javascripts/discourse/components/ai-bot-conversations.gjs
@@ -99,7 +99,7 @@ export default class AiBotConversations extends Component {
constructor() {
super(...arguments);
- this.uppyUpload = new UppyUpload(getOwner(this), {
+ this.uppyUpload = new UppyUpload(this, {
id: "ai-bot-file-uploader",
type: "ai-bot-conversation",
useMultipartUploadsIfAvailable: true,
@@ -143,7 +143,6 @@ export default class AiBotConversations extends Component {
willDestroy() {
super.willDestroy(...arguments);
this.textarea?.removeEventListener("paste", this.#handlePaste);
- this.uppyUpload?.teardown();
// needed for safety (textarea may not have a autocomplete)
if (this.textarea.autocomplete) {
this.textarea.autocomplete("destroy");
diff --git a/plugins/discourse-ai/assets/javascripts/discourse/components/rag-uploader.gjs b/plugins/discourse-ai/assets/javascripts/discourse/components/rag-uploader.gjs
index 4751b012c63..313d6188175 100644
--- a/plugins/discourse-ai/assets/javascripts/discourse/components/rag-uploader.gjs
+++ b/plugins/discourse-ai/assets/javascripts/discourse/components/rag-uploader.gjs
@@ -4,7 +4,6 @@ import Component, { Input } from "@ember/component";
import { fn } from "@ember/helper";
import { on } from "@ember/modifier";
import { action } from "@ember/object";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import { service } from "@ember/service";
import { tagName } from "@ember-decorators/component";
@@ -27,7 +26,7 @@ export default class RagUploader extends Component {
@tracked ragIndexingStatuses = null;
@autoTrackedArray ragUploads = null;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
id: "discourse-ai-rag-uploader",
maxFiles: 20,
type: "discourse_ai_rag_upload",
@@ -46,7 +45,7 @@ export default class RagUploader extends Component {
willDestroy() {
super.willDestroy(...arguments);
this.appEvents.off(
- `upload-mixin:${this.uppyUpload.config}:all-uploads-complete`,
+ `upload-mixin:${this.uppyUpload.config.id}:all-uploads-complete`,
this,
"_updateTargetWithUploads"
);
diff --git a/plugins/discourse-events/assets/javascripts/discourse/components/csv-uploader.gjs b/plugins/discourse-events/assets/javascripts/discourse/components/csv-uploader.gjs
index b9a6ccb2f8e..699ffd9ede3 100644
--- a/plugins/discourse-events/assets/javascripts/discourse/components/csv-uploader.gjs
+++ b/plugins/discourse-events/assets/javascripts/discourse/components/csv-uploader.gjs
@@ -1,5 +1,4 @@
import Component from "@glimmer/component";
-import { getOwner } from "@ember/owner";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import { service } from "@ember/service";
import UppyUpload from "discourse/lib/uppy/uppy-upload";
@@ -10,7 +9,7 @@ import { i18n } from "discourse-i18n";
export default class CsvUploader extends Component {
@service dialog;
- uppyUpload = new UppyUpload(getOwner(this), {
+ uppyUpload = new UppyUpload(this, {
type: "csv",
id: "discourse-post-event-csv-uploader",
autoStartUploads: false,