A platform for community discussion. Free, open, simple.
UX: Migrate permanently-delete confirmation to DModal (#39896)
Régis Hanol28dae66fb150
diff --git a/app/assets/stylesheets/common/base/dialog.scss b/app/assets/stylesheets/common/base/dialog.scssindex 801630e44dd..c06e0133cde 100644--- a/app/assets/stylesheets/common/base/dialog.scss+++ b/app/assets/stylesheets/common/base/dialog.scss@@ -84,95 +84,6 @@}}-.permanently-delete-confirm {- .dialog-content {- min-width: 25vw;- width: 25vw;- }-- &.--fire-easter-egg-dialog {- .dialog-content {- background-color: transparent;- color: white;-- .confirmation-phrase {- z-index: 100000;- }- }- }-- &__message {- margin-bottom: var(--space-4);- }-- &__instruction {- display: flex;- flex-direction: column;- gap: 0.5em;-- .confirmation-phrase {- width: 100%;- margin: 0;- }- }-- --glitter: url("/images/firenoise.png");-- .fire-easter-egg::before,- .fire-easter-egg::after {- content: "";- position: absolute;- inset: 0;- }-- .fire-easter-egg::before {- content: "";- background-image:- var(--glitter), var(--glitter),- linear-gradient(- 0deg,- white 0,- #ff8951 5px,- #dcbc169c 30%,- transparent 70%- ),- radial-gradient(ellipse at bottom, transparent 30%, black 60%);- background-size:- 350px 500px,- 400px 650px,- 100% 100%,- 100% 100%;- background-blend-mode: hard-light, color-dodge, multiply;- background-position:- 0 0,- 0 0,- var(--gradientPos);- background-repeat: repeat, repeat, repeat, no-repeat;- mix-blend-mode: color-dodge;- filter: brightness(3.7) blur(7px) contrast(6);- animation: fire-easter-egg 1.75s linear infinite;- box-shadow: inset 0 -40px 50px -60px #63bbc5;- }-- @keyframes fire-easter-egg {- 0% {- background-position:- center 0,- center 0,- 50% 100%,- center center;- }-- 100% {- background-position:- center -500px,- center -650px,- 50% 100%,- center center;- }- }-}-.dialog-footer {display: flex;flex-wrap: wrap;diff --git a/app/assets/stylesheets/common/base/modal.scss b/app/assets/stylesheets/common/base/modal.scssindex 3b0395263ea..709732c2ce5 100644--- a/app/assets/stylesheets/common/base/modal.scss+++ b/app/assets/stylesheets/common/base/modal.scss@@ -825,3 +825,92 @@ html:not(.keyboard-visible).mobile-device {margin-left: auto;}}++.permanently-delete-confirm-modal {+ .d-modal__footer .btn-danger {+ white-space: normal;+ text-align: left;+ }++ &.--fire-easter-egg-modal {+ .d-modal__container {+ background-color: transparent;+ color: white;++ .confirmation-phrase {+ z-index: 100000;+ }+ }+ }++ &__message {+ margin-bottom: var(--space-4);+ }++ &__instruction {+ display: flex;+ flex-direction: column;+ gap: 0.5em;++ .confirmation-phrase {+ width: 100%;+ margin: 0;+ }+ }++ --glitter: url("/images/firenoise.png");++ .fire-easter-egg::before,+ .fire-easter-egg::after {+ content: "";+ position: absolute;+ inset: 0;+ }++ .fire-easter-egg::before {+ content: "";+ background-image:+ var(--glitter), var(--glitter),+ linear-gradient(+ 0deg,+ white 0,+ #ff8951 5px,+ #dcbc169c 30%,+ transparent 70%+ ),+ radial-gradient(ellipse at bottom, transparent 30%, black 60%);+ background-size:+ 350px 500px,+ 400px 650px,+ 100% 100%,+ 100% 100%;+ background-blend-mode: hard-light, color-dodge, multiply;+ background-position:+ 0 0,+ 0 0,+ var(--gradientPos);+ background-repeat: repeat, repeat, repeat, no-repeat;+ mix-blend-mode: color-dodge;+ filter: brightness(3.7) blur(7px) contrast(6);+ animation: fire-easter-egg 1.75s linear infinite;+ box-shadow: inset 0 -40px 50px -60px #63bbc5;+ }++ @keyframes fire-easter-egg {+ 0% {+ background-position:+ center 0,+ center 0,+ 50% 100%,+ center center;+ }++ 100% {+ background-position:+ center -500px,+ center -650px,+ 50% 100%,+ center center;+ }+ }+}diff --git a/frontend/discourse/app/components/dialog-messages/permanently-delete-confirm.gjs b/frontend/discourse/app/components/dialog-messages/permanently-delete-confirm.gjsdeleted file mode 100644index a8e2bf31ae6..00000000000--- a/frontend/discourse/app/components/dialog-messages/permanently-delete-confirm.gjs+++ /dev/null@@ -1,100 +0,0 @@-import Component from "@glimmer/component";-import { tracked } from "@glimmer/tracking";-import { on } from "@ember/modifier";-import { action } from "@ember/object";-import { service } from "@ember/service";-import { trustHTML } from "@ember/template";-import discourseDebounce from "discourse/lib/debounce";-import getURL from "discourse/lib/get-url";-import { i18n } from "discourse-i18n";--export function buildPermanentlyDeleteConfirmDialogArgs(- message,- confirmPhrase,- didConfirm,- overrideOpts = {}-) {- return {- title: overrideOpts.title || i18n("permanently_delete.title"),- class: overrideOpts.class || "permanently-delete-confirm",- bodyComponent: PermanentlyDeleteConfirm,- bodyComponentModel: {- message,- confirmPhrase,- },- confirmButtonLabel:- overrideOpts.confirmButtonLabel || "permanently_delete.controls.delete",- confirmButtonClass: "btn-danger",- confirmButtonDisabled: true,- didConfirm,- };-}--export default class PermanentlyDeleteConfirm extends Component {- @service dialog;-- @tracked inputtedConfirmPhrase;-- confirmPhrase = this.args.model.confirmPhrase.trim().toLocaleLowerCase();- originalDialogClass = this.dialog.class;-- #easterEggAudio;-- @action- onInput(event) {- this.inputtedConfirmPhrase = event.target.value.trim().toLocaleLowerCase();-- this.dialog.set(- "confirmButtonDisabled",- this.inputtedConfirmPhrase !== this.confirmPhrase- );-- if (this.showEasterEgg) {- this.dialog.set("class", this.dialog.class + " --fire-easter-egg-dialog");- } else {- this.dialog.set("class", this.originalDialogClass);- }-- discourseDebounce(this, this.maybePlayEasterEggSound, 300);- }-- maybePlayEasterEggSound() {- if (!this.showEasterEgg) {- return;- }- this.#easterEggAudio ??= new Audio(getURL("/audio/firelaugh.mp3"));- this.#easterEggAudio.currentTime = 0;- this.#easterEggAudio.play();- }-- get showEasterEgg() {- return (- this.inputtedConfirmPhrase === this.confirmPhrase + " below to confirm"- );- }-- <template>- <div class="permanently-delete-confirm__message">{{trustHTML- @model.message- }}</div>- <div class="permanently-delete-confirm__instruction">- <span>{{trustHTML- (i18n- "permanently_delete.confirm_instruction" [email protected]- )- }}</span>- <input- {{on "input" this.onInput}}- name="confirmationPhrase"- type="text"- class="confirmation-phrase"- placeholder={{@model.confirmPhrase}}- />-- {{#if this.showEasterEgg}}- Comedian, eh?- <div class="fire-easter-egg"></div>- {{/if}}- </div>- </template>-}diff --git a/frontend/discourse/app/components/modal/history.gjs b/frontend/discourse/app/components/modal/history.gjsindex 2553743bde8..68eb15ac664 100644--- a/frontend/discourse/app/components/modal/history.gjs+++ b/frontend/discourse/app/components/modal/history.gjs@@ -3,10 +3,10 @@ import { tracked } from "@glimmer/tracking";import { concat } from "@ember/helper";import { action } from "@ember/object";import { service } from "@ember/service";-import { buildPermanentlyDeleteConfirmDialogArgs } from "discourse/components/dialog-messages/permanently-delete-confirm";import Revision from "discourse/components/modal/history/revision";import Revisions from "discourse/components/modal/history/revisions";import TopicFooter from "discourse/components/modal/history/topic-footer";+import PermanentlyDeleteConfirmModal from "discourse/components/modal/permanently-delete-confirm";import { iconHTML } from "discourse/lib/icon-library";import { sanitizeAsync } from "discourse/lib/text";import Category from "discourse/models/category";@@ -29,6 +29,7 @@ function customTagArray(val) {export default class History extends Component {@service dialog;+ @service modal;@service site;@service currentUser;@service siteSettings;@@ -355,15 +356,15 @@ export default class History extends Component {const postId = this.postRevision?.post_id;this.args.closeModal();- this.dialog.confirm(- buildPermanentlyDeleteConfirmDialogArgs(- i18n("post.revisions.controls.destroy_confirm"),- i18n("post.controls.permanently_delete_confirm_phrase"),- () => {+ this.modal.show(PermanentlyDeleteConfirmModal, {+ model: {+ message: i18n("post.revisions.controls.destroy_confirm"),+ confirmPhrase: i18n("post.controls.permanently_delete_confirm_phrase"),+ didConfirm: () => {Post.permanentlyDeleteRevisions(postId);- }- )- );+ },+ },+ });}@actiondiff --git a/frontend/discourse/app/components/modal/permanently-delete-confirm.gjs b/frontend/discourse/app/components/modal/permanently-delete-confirm.gjsnew file mode 100644index 00000000000..eead0029ef5--- /dev/null+++ b/frontend/discourse/app/components/modal/permanently-delete-confirm.gjs@@ -0,0 +1,100 @@+import Component from "@glimmer/component";+import { tracked } from "@glimmer/tracking";+import { on } from "@ember/modifier";+import { action } from "@ember/object";+import { trustHTML } from "@ember/template";+import discourseDebounce from "discourse/lib/debounce";+import getURL from "discourse/lib/get-url";+import { not } from "discourse/truth-helpers";+import DButton from "discourse/ui-kit/d-button";+import DModal from "discourse/ui-kit/d-modal";+import DModalCancel from "discourse/ui-kit/d-modal-cancel";+import dConcatClass from "discourse/ui-kit/helpers/d-concat-class";+import { i18n } from "discourse-i18n";++export default class PermanentlyDeleteConfirm extends Component {+ @tracked inputtedConfirmPhrase = "";++ #easterEggAudio;++ get confirmPhrase() {+ return this.args.model.confirmPhrase.trim().toLocaleLowerCase();+ }++ get phraseMatches() {+ return this.inputtedConfirmPhrase === this.confirmPhrase;+ }++ get showEasterEgg() {+ return (+ this.inputtedConfirmPhrase === this.confirmPhrase + " below to confirm"+ );+ }++ @action+ onInput(event) {+ this.inputtedConfirmPhrase = event.target.value.trim().toLocaleLowerCase();+ discourseDebounce(this, this.maybePlayEasterEggSound, 300);+ }++ maybePlayEasterEggSound() {+ if (!this.showEasterEgg) {+ return;+ }+ this.#easterEggAudio ??= new Audio(getURL("/audio/firelaugh.mp3"));+ this.#easterEggAudio.currentTime = 0;+ this.#easterEggAudio.play();+ }++ @action+ confirm() {+ this.args.model.didConfirm?.();+ this.args.closeModal();+ }++ <template>+ <DModal+ @title={{i18n "permanently_delete.title"}}+ @closeModal={{@closeModal}}+ class={{dConcatClass+ "permanently-delete-confirm-modal"+ (if this.showEasterEgg "--fire-easter-egg-modal")+ }}+ >+ <:body>+ <div class="permanently-delete-confirm-modal__message">{{trustHTML+ @model.message+ }}</div>+ <div class="permanently-delete-confirm-modal__instruction">+ <span>{{trustHTML+ (i18n+ "permanently_delete.confirm_instruction"+ )+ }}</span>+ <input+ {{on "input" this.onInput}}+ name="confirmationPhrase"+ type="text"+ class="confirmation-phrase"+ placeholder={{@model.confirmPhrase}}+ />++ {{#if this.showEasterEgg}}+ Comedian, eh?+ <div class="fire-easter-egg"></div>+ {{/if}}+ </div>+ </:body>+ <:footer>+ <DButton+ @action={{this.confirm}}+ @disabled={{not this.phraseMatches}}+ @label="permanently_delete.controls.delete"+ class="btn-danger"+ />+ <DModalCancel @close={{@closeModal}} />+ </:footer>+ </DModal>+ </template>+}diff --git a/frontend/discourse/app/controllers/topic.js b/frontend/discourse/app/controllers/topic.jsindex af76378001d..99e02cb97dd 100644--- a/frontend/discourse/app/controllers/topic.js+++ b/frontend/discourse/app/controllers/topic.js@@ -10,12 +10,12 @@ import { observes } from "@ember-decorators/object";import BufferedProxy from "ember-buffered-proxy/proxy";import { Promise } from "rsvp";import DEditorOriginalTranslationPreview from "discourse/components/d-editor-original-translation-preview";-import { buildPermanentlyDeleteConfirmDialogArgs } from "discourse/components/dialog-messages/permanently-delete-confirm";import BookmarkModal from "discourse/components/modal/bookmark";import ChangePostNoticeModal from "discourse/components/modal/change-post-notice";import ConvertToPublicTopicModal from "discourse/components/modal/convert-to-public-topic";import DeleteTopicConfirmModal from "discourse/components/modal/delete-topic-confirm";import JumpToPost from "discourse/components/modal/jump-to-post";+import PermanentlyDeleteConfirmModal from "discourse/components/modal/permanently-delete-confirm";import { MIN_POSTS_COUNT } from "discourse/components/topic-map/topic-map-summary";import { ajax } from "discourse/lib/ajax";import { popupAjaxError } from "discourse/lib/ajax-error";@@ -1054,15 +1054,15 @@ export default class TopicController extends Controller {? i18n("post.controls.permanently_delete_topic_confirmation"): i18n("post.controls.permanently_delete_post_confirmation");- return this.dialog.confirm(- buildPermanentlyDeleteConfirmDialogArgs(+ return this.modal.show(PermanentlyDeleteConfirmModal, {+ model: {message,- i18n("post.controls.permanently_delete_confirm_phrase"),- () => {+ confirmPhrase: i18n("post.controls.permanently_delete_confirm_phrase"),+ didConfirm: () => {this.send("deletePost", post, { force_destroy: true });- }- )- );+ },+ },+ });}@actiondiff --git a/frontend/discourse/tests/integration/components/dialog-holder-test.gjs b/frontend/discourse/tests/integration/components/dialog-holder-test.gjsindex aba220f377f..3c25ca7eeb0 100644--- a/frontend/discourse/tests/integration/components/dialog-holder-test.gjs+++ b/frontend/discourse/tests/integration/components/dialog-holder-test.gjs@@ -9,7 +9,6 @@ import {} from "@ember/test-helpers";import { module, test } from "qunit";import GroupDeleteDialogMessage from "discourse/components/dialog-messages/group-delete";-import PermanentlyDeleteConfirm from "discourse/components/dialog-messages/permanently-delete-confirm";import SecondFactorConfirmPhrase from "discourse/components/dialog-messages/second-factor-confirm-phrase";import DialogHolder from "discourse/dialog-holder/components/dialog-holder";import { setupRenderingTest } from "discourse/tests/helpers/component-test";@@ -311,40 +310,6 @@ module("Integration | Component | dialog-holder", function (hooks) {assert.dom(".btn-danger").isEnabled();});- test("permanently delete confirm with typed confirmation phrase", async function (assert) {- await render(<template><DialogHolder /></template>);-- const confirmPhrase = i18n(- "post.controls.permanently_delete_confirm_phrase"- );-- this.dialog.confirm({- bodyComponent: PermanentlyDeleteConfirm,- bodyComponentModel: {- message: "Are you sure?",- confirmPhrase: i18n("post.controls.permanently_delete_confirm_phrase"),- },- confirmButtonClass: "btn-danger",- confirmButtonDisabled: true,- });- await settled();-- assert.dom(".dialog-body").includesText("Are you sure?");- assert.dom(".btn-danger").isDisabled();-- await fillIn("input.confirmation-phrase", "wrong");- assert.dom(".btn-danger").isDisabled();-- await fillIn("input.confirmation-phrase", confirmPhrase);- assert.dom(".btn-danger").isEnabled();-- await fillIn("input.confirmation-phrase", confirmPhrase.toUpperCase());- assert.dom(".btn-danger").isEnabled();-- await fillIn("input.confirmation-phrase", ` ${confirmPhrase} `);- assert.dom(".btn-danger").isEnabled();- });-test("delete confirm with a component and model", async function (assert) {await render(<template><DialogHolder /></template>);const message_count = 5;diff --git a/spec/system/page_objects/modals/permanently_delete_confirm.rb b/spec/system/page_objects/modals/permanently_delete_confirm.rbnew file mode 100644index 00000000000..cc1df92be2c--- /dev/null+++ b/spec/system/page_objects/modals/permanently_delete_confirm.rb@@ -0,0 +1,21 @@+# frozen_string_literal: true++module PageObjects+ module Modals+ class PermanentlyDeleteConfirm < PageObjects::Modals::Base+ MODAL_SELECTOR = ".permanently-delete-confirm-modal"++ def fill_in_confirmation_phrase(phrase)+ body.find("input.confirmation-phrase").fill_in(with: phrase)+ end++ def click_danger+ footer.find(".btn-danger").click+ end++ def has_confirm_button_disabled?+ has_css?("#{footer_selector} .btn-danger[disabled]")+ end+ end+ end+enddiff --git a/spec/system/permanently_delete_spec.rb b/spec/system/permanently_delete_spec.rbindex 2eeb083a673..a32a1ea9dbf 100644--- a/spec/system/permanently_delete_spec.rb+++ b/spec/system/permanently_delete_spec.rb@@ -8,6 +8,7 @@ describe "Permanently delete" dolet(:topic_page) { PageObjects::Pages::Topic.new }let(:dialog) { PageObjects::Components::Dialog.new }+ let(:confirm_modal) { PageObjects::Modals::PermanentlyDeleteConfirm.new }let(:confirmation_phrase) { I18n.t("js.post.controls.permanently_delete_confirm_phrase") }@@ -23,8 +24,8 @@ describe "Permanently delete" doit "permanently deletes the post after confirmation" dotopic_page.permanently_delete_post(post)- dialog.fill_in_confirmation_phrase(confirmation_phrase)- dialog.click_danger+ confirm_modal.fill_in_confirmation_phrase(confirmation_phrase)+ confirm_modal.click_dangerexpect(page).to have_no_css("#post_#{post.post_number}")expect(Post.unscoped.exists?(post.id)).to eq(false)@@ -32,9 +33,9 @@ describe "Permanently delete" doit "does not delete the post when cancelling" dotopic_page.permanently_delete_post(post)- dialog.click_no+ confirm_modal.cancel- expect(dialog).to be_closed+ expect(confirm_modal).to be_closedexpect(topic_page).to have_deleted_post(post)expect(Post.unscoped.exists?(post.id)).to eq(true)end@@ -70,8 +71,8 @@ describe "Permanently delete" doit "permanently deletes the topic after confirmation" dotopic_page.permanently_delete_post(first_post)- dialog.fill_in_confirmation_phrase(confirmation_phrase)- dialog.click_danger+ confirm_modal.fill_in_confirmation_phrase(confirmation_phrase)+ confirm_modal.click_dangerexpect(page).to have_current_path("/")expect(Topic.unscoped.exists?(topic.id)).to eq(false)@@ -109,9 +110,9 @@ describe "Permanently delete" doexpect(post_history_modal).to have_destroy_revisions_buttonpost_history_modal.destroy_revisions- expect(dialog).to be_open- dialog.fill_in_confirmation_phrase(confirmation_phrase)- dialog.click_danger+ expect(confirm_modal).to be_open+ confirm_modal.fill_in_confirmation_phrase(confirmation_phrase)+ confirm_modal.click_dangerexpect(page).to have_no_css("#post_#{post_with_revisions.post_number} .post-info.edits")expect(PostRevision.exists?(revision_id)).to eq(false)