Skip to content

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

UX: Preview image and video uploads in the chat composer (#43909)

Renato Atilio171ac011097e
diff --git a/frontend/discourse/app/lib/uppy/uppy-upload.js b/frontend/discourse/app/lib/uppy/uppy-upload.js
index 1c5780ad51e..24ad85e8b46 100644
--- a/frontend/discourse/app/lib/uppy/uppy-upload.js
+++ b/frontend/discourse/app/lib/uppy/uppy-upload.js
@@ -281,6 +281,7 @@ export default class UppyUpload {
progress: 0,
extension: file.extension,
processing: false,
+ data: file.data,
})
);
this.#triggerInProgressUploadsEvent();
diff --git a/plugins/chat/assets/javascripts/discourse/components/chat-composer-upload.gjs b/plugins/chat/assets/javascripts/discourse/components/chat-composer-upload.gjs
index 7df15a1b1b2..047549c7035 100644
--- a/plugins/chat/assets/javascripts/discourse/components/chat-composer-upload.gjs
+++ b/plugins/chat/assets/javascripts/discourse/components/chat-composer-upload.gjs
@@ -1,4 +1,5 @@
import Component from "@glimmer/component";
+import { service } from "@ember/service";
import { getURLWithCDN } from "discourse/lib/get-url";
import { isAudio, isImage, isVideo } from "discourse/lib/uploads";
import DButton from "discourse/ui-kit/d-button";
@@ -7,14 +8,63 @@ import dIcon from "discourse/ui-kit/helpers/d-icon";
import { i18n } from "discourse-i18n";
export default class ChatComposerUpload extends Component {
+ @service capabilities;
+
+ #localPreviewUrl = null;
+
+ constructor() {
+ super(...arguments);
+
+ const data = this.args.upload?.data;
+ if (!this.args.isDone && data instanceof Blob && this.isMedia) {
+ this.#localPreviewUrl = URL.createObjectURL(data);
+ }
+ }
+
+ willDestroy() {
+ super.willDestroy(...arguments);
+ if (this.#localPreviewUrl) {
+ URL.revokeObjectURL(this.#localPreviewUrl);
+ }
+ }
+
get fileName() {
return this.args.isDone
? this.args.upload.original_filename
: this.args.upload.fileName;
}
+ get isImage() {
+ return isImage(this.fileName);
+ }
+
+ get isVideo() {
+ return isVideo(this.fileName);
+ }
+
+ get isMedia() {
+ return this.isImage || this.isVideo;
+ }
+
get previewImageSrc() {
- return getURLWithCDN(this.args.upload?.url);
+ return this.#localPreviewUrl ?? getURLWithCDN(this.args.upload?.url);
+ }
+
+ get previewVideoSrc() {
+ const url =
+ this.#localPreviewUrl ??
+ getURLWithCDN(
+ this.args.upload?.optimized_video?.url ?? this.args.upload?.url
+ );
+
+ // Safari only paints the first frame when a time fragment is set
+ return this.capabilities.isIOS || this.capabilities.isSafari
+ ? `${url}#t=0.001`
+ : url;
+ }
+
+ get hasPreview() {
+ return this.isMedia && Boolean(this.args.isDone || this.#localPreviewUrl);
}
<template>
@@ -22,19 +72,32 @@ export default class ChatComposerUpload extends Component {
<div
class={{dConcatClass
"chat-composer-upload"
- (if (isImage this.fileName) "chat-composer-upload--image")
+ (if this.isImage "chat-composer-upload--image")
+ (if this.isVideo "chat-composer-upload--video")
+ (if this.hasPreview "chat-composer-upload--with-preview")
(unless @isDone "chat-composer-upload--in-progress")
}}
>
<div class="preview">
- {{#if (isImage this.fileName)}}
- {{#if @isDone}}
+ {{#if this.isImage}}
+ {{#if this.hasPreview}}
<img class="preview-img" src={{this.previewImageSrc}} />
{{else}}
{{dIcon "far-image"}}
{{/if}}
- {{else if (isVideo this.fileName)}}
- {{dIcon "file-video"}}
+ {{else if this.isVideo}}
+ {{#if this.hasPreview}}
+ <video
+ class="preview-video"
+ muted
+ playsinline
+ preload="metadata"
+ src={{this.previewVideoSrc}}
+ ></video>
+ {{dIcon "play" class="preview-video__badge"}}
+ {{else}}
+ {{dIcon "file-video"}}
+ {{/if}}
{{else if (isAudio this.fileName)}}
{{dIcon "file-audio"}}
{{else}}
@@ -43,7 +106,7 @@ export default class ChatComposerUpload extends Component {
</div>
<span class="data">
- {{#unless (isImage this.fileName)}}
+ {{#unless this.hasPreview}}
<div class="top-data">
<span class="file-name">{{this.fileName}}</span>
</div>
@@ -51,15 +114,17 @@ export default class ChatComposerUpload extends Component {
<div class="bottom-data">
{{#if @isDone}}
- {{#unless (isImage this.fileName)}}
+ {{#unless this.isMedia}}
<span class="extension-pill">{{@upload.extension}}</span>
{{/unless}}
{{else}}
- {{#if @upload.processing}}
- <span class="processing">{{i18n "processing"}}</span>
- {{else}}
- <span class="uploading">{{i18n "uploading"}}</span>
- {{/if}}
+ {{#unless this.hasPreview}}
+ {{#if @upload.processing}}
+ <span class="processing">{{i18n "processing"}}</span>
+ {{else}}
+ <span class="uploading">{{i18n "uploading"}}</span>
+ {{/if}}
+ {{/unless}}
<progress
class="upload-progress"
diff --git a/plugins/chat/assets/stylesheets/common/chat-composer-upload.scss b/plugins/chat/assets/stylesheets/common/chat-composer-upload.scss
index 6abda2d5f00..55a592c9e08 100644
--- a/plugins/chat/assets/stylesheets/common/chat-composer-upload.scss
+++ b/plugins/chat/assets/stylesheets/common/chat-composer-upload.scss
@@ -8,14 +8,37 @@
border-radius: var(--d-border-radius);
box-sizing: border-box;
- &--image:not(.chat-composer-upload--in-progress) {
+ &--with-preview {
padding: 0;
- .preview-img {
+ .preview-img,
+ .preview-video {
height: 62px;
width: 62px;
box-sizing: border-box;
}
+
+ &.chat-composer-upload--in-progress {
+ .preview-img,
+ .preview-video {
+ opacity: 0.5;
+ }
+
+ .data {
+ position: absolute;
+ inset: auto 0 0 0;
+ }
+
+ .bottom-data {
+ justify-content: center;
+ }
+
+ .data .upload-progress {
+ width: 100%;
+ height: 4px;
+ border-radius: 0;
+ }
+ }
}
&:last-child {
@@ -53,11 +76,26 @@
margin-right: 0.5rem;
}
- .preview-img {
+ .preview-img,
+ .preview-video {
object-position: center;
object-fit: cover;
border-radius: var(--d-border-radius);
}
+
+ .preview-video__badge {
+ position: absolute;
+ top: 50%;
+ left: 50%;
+ transform: translate(-50%, -50%);
+ font-size: var(--font-up-1);
+ color: #fff;
+ background: rgb(var(--always-black-rgb), 0.6);
+ border-radius: 100%;
+ padding: 0.35em;
+ margin: 0;
+ pointer-events: none;
+ }
}
.data {
diff --git a/plugins/chat/test/javascripts/components/chat-composer-upload-test.gjs b/plugins/chat/test/javascripts/components/chat-composer-upload-test.gjs
index a7e0cb3cf7c..66bc265939f 100644
--- a/plugins/chat/test/javascripts/components/chat-composer-upload-test.gjs
+++ b/plugins/chat/test/javascripts/components/chat-composer-upload-test.gjs
@@ -1,8 +1,10 @@
import { fn } from "@ember/helper";
-import { click, render } from "@ember/test-helpers";
+import { clearRender, click, render } from "@ember/test-helpers";
import { module, test } from "qunit";
+import sinon from "sinon";
import { restoreBaseUri, setupURL } from "discourse/lib/get-url";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
+import { createFile } from "discourse/tests/helpers/qunit-helpers";
import { i18n } from "discourse-i18n";
import ChatComposerUpload from "discourse/plugins/chat/discourse/components/chat-composer-upload";
@@ -40,6 +42,98 @@ module("Component | ChatComposerUpload", function (hooks) {
assert.dom(".uploading").hasText(i18n("uploading"));
});
+ test("image - uploading in progress with local file previews it", async function (assert) {
+ this.set("upload", {
+ extension: ".png",
+ progress: 78,
+ fileName: "test.png",
+ data: createFile("test.png", "image/png"),
+ });
+
+ await render(
+ <template><ChatComposerUpload @upload={{this.upload}} /></template>
+ );
+
+ assert.dom(".chat-composer-upload--with-preview").exists();
+ assert.dom("img.preview-img").hasAttribute("src", /^blob:/);
+ assert.dom(".file-name").doesNotExist();
+ assert.dom(".upload-progress[value='78']").exists();
+ });
+
+ test("image - revokes the local preview url on teardown", async function (assert) {
+ const revoke = sinon.spy(URL, "revokeObjectURL");
+ this.set("upload", {
+ extension: ".png",
+ progress: 10,
+ fileName: "test.png",
+ data: createFile("test.png", "image/png"),
+ });
+
+ await render(
+ <template><ChatComposerUpload @upload={{this.upload}} /></template>
+ );
+
+ const src = document.querySelector("img.preview-img").getAttribute("src");
+ await clearRender();
+
+ assert.true(revoke.calledOnceWith(src));
+ });
+
+ test("video - uploading in progress with local file previews it", async function (assert) {
+ this.set("upload", {
+ extension: ".mp4",
+ progress: 20,
+ fileName: "clip.mp4",
+ data: createFile("clip.mp4", "video/mp4"),
+ });
+
+ await render(
+ <template><ChatComposerUpload @upload={{this.upload}} /></template>
+ );
+
+ assert
+ .dom(".chat-composer-upload--video.chat-composer-upload--with-preview")
+ .exists();
+ assert.dom("video.preview-video").hasAttribute("src", /^blob:/);
+ assert.dom(".preview-video__badge").exists();
+ assert.dom(".upload-progress[value='20']").exists();
+ });
+
+ test("video - uploading in progress without local file", async function (assert) {
+ this.set("upload", {
+ extension: ".mp4",
+ progress: 20,
+ fileName: "clip.mp4",
+ });
+
+ await render(
+ <template><ChatComposerUpload @upload={{this.upload}} /></template>
+ );
+
+ assert.dom(".d-icon-file-video").exists();
+ assert.dom(".file-name").hasText("clip.mp4");
+ });
+
+ test("video - upload complete", async function (assert) {
+ this.set("upload", {
+ original_filename: "clip.mp4",
+ extension: "mp4",
+ url: "/uploads/clip.mp4",
+ });
+
+ await render(
+ <template>
+ <ChatComposerUpload @isDone={{true}} @upload={{this.upload}} />
+ </template>
+ );
+
+ assert
+ .dom("video.preview-video")
+ .hasAttribute("src", /^\/uploads\/clip\.mp4/);
+ assert.dom(".file-name").doesNotExist();
+ assert.dom(".extension-pill").doesNotExist();
+ });
+
test("image - preprocessing upload in progress", async function (assert) {
this.set("upload", {
extension: ".png",