From dd3d84a8a5093cb10a096495e883879ee567e757 Mon Sep 17 00:00:00 2001 From: Kevin Ansfield Date: Thu, 12 May 2022 15:28:35 +0100 Subject: [PATCH] Added separate "published but email failed" state to publish flow refs https://github.com/TryGhost/Team/issues/1587 - if post creation succeeds but the email fails to send we want to show a separate state of the publish flow rather than adding an error to the confirm step - confirm _has_ completed so showing the error there doesn't make sense and causes confusing copy - added check for email failure to the `` save task (which is called by the confirm step) to intercept any email failure errors and switch state --- .../editor-labs/modals/publish-flow.hbs | 13 +++- .../editor-labs/modals/publish-flow.js | 15 +++- .../complete-with-email-error.hbs | 46 ++++++++++++ .../publish-flow/complete-with-email-error.js | 71 +++++++++++++++++++ .../modals/publish-flow/confirm.hbs | 16 ----- .../modals/publish-flow/confirm.js | 7 -- .../editor-labs/publish-management.js | 4 +- 7 files changed, 141 insertions(+), 31 deletions(-) create mode 100644 ghost/admin/app/components/editor-labs/modals/publish-flow/complete-with-email-error.hbs create mode 100644 ghost/admin/app/components/editor-labs/modals/publish-flow/complete-with-email-error.js diff --git a/ghost/admin/app/components/editor-labs/modals/publish-flow.hbs b/ghost/admin/app/components/editor-labs/modals/publish-flow.hbs index 3b04caee2d..fad0f8a95a 100644 --- a/ghost/admin/app/components/editor-labs/modals/publish-flow.hbs +++ b/ghost/admin/app/components/editor-labs/modals/publish-flow.hbs @@ -4,7 +4,7 @@ {{svg-jar "arrow-left"}} Editor - {{#unless this.isComplete}} + {{#if (and (not this.emailErrorMessage) (not this.isComplete))}}
- {{/unless}} + {{/if}}
- {{#if this.isConfirming}} + {{#if this.emailErrorMessage}} + + {{else if this.isConfirming}} + Boom. It’s out there. + + {{#if post.emailOnly}} + Your email has been created. + {{else if (and post.isPost @postCount)}} + That’s {{@postCount}} posts published, keep going! + {{else}} + Your {{post.displayName}} has been published. + {{/if}} +
+ +

+ {{svg-jar "warning"}} + + {{#if @publishOptions.willOnlyEmail}} + Your post has been created but the email failed to send. + {{else}} + Your post has been published but the email failed to send. + {{/if}} + + Please verify your email settings if the error persists. +

+ Email error: {{this.emailErrorMessage}} +

+ + {{#if this.retryErrorMessage}} +

+ {{svg-jar "warning"}} + {{this.retryErrorMessage}} +

+ {{/if}} + +
+ +
+{{/let}} + diff --git a/ghost/admin/app/components/editor-labs/modals/publish-flow/complete-with-email-error.js b/ghost/admin/app/components/editor-labs/modals/publish-flow/complete-with-email-error.js new file mode 100644 index 0000000000..a15301b5b3 --- /dev/null +++ b/ghost/admin/app/components/editor-labs/modals/publish-flow/complete-with-email-error.js @@ -0,0 +1,71 @@ +import Component from '@glimmer/component'; +import EmailFailedError from 'ghost-admin/errors/email-failed-error'; +import {CONFIRM_EMAIL_MAX_POLL_LENGTH, CONFIRM_EMAIL_POLL_LENGTH} from '../../publish-management'; +import {htmlSafe} from '@ember/template'; +import {isServerUnreachableError} from 'ghost-admin/services/ajax'; +import {task, timeout} from 'ember-concurrency'; +import {tracked} from '@glimmer/tracking'; + +function isString(str) { + return toString.call(str) === '[object String]'; +} + +export default class PublishFlowCompleteWithEmailError extends Component { + @tracked newEmailErrorMessage; + @tracked retryErrorMessage; + + get emailErrorMessage() { + return this.newEmailErrorMessage || this.args.emailErrorMessage; + } + + @task({drop: true}) + *retryEmailTask() { + this.retryErrorMessage = null; + + try { + let email = yield this.args.publishOptions.post.email.retry(); + + let pollTimeout = 0; + if (email && email.status !== 'submitted') { + while (pollTimeout < CONFIRM_EMAIL_MAX_POLL_LENGTH) { + yield timeout(CONFIRM_EMAIL_POLL_LENGTH); + pollTimeout += CONFIRM_EMAIL_POLL_LENGTH; + + email = yield email.reload(); + + if (email.status === 'submitted') { + break; + } + if (email.status === 'failed') { + throw new EmailFailedError(email.error); + } + } + } + + return email; + } catch (e) { + // update "failed" state if email fails again + if (e && e.name === 'EmailFailedError') { + this.newEmailErrorMessage = e.message; + return false; + } + + if (e) { + let errorMessage = ''; + + if (isServerUnreachableError(e)) { + errorMessage = 'Unable to connect, please check your internet connection and try again.'; + } else if (e && isString(e)) { + errorMessage = e; + } else if (e?.payload?.errors?.[0].message) { + errorMessage = e.payload.errors[0].message; + } else { + errorMessage = 'Unknown Error occurred when attempting to resend'; + } + + this.retryErrorMessage = htmlSafe(errorMessage); + return false; + } + } + } +} diff --git a/ghost/admin/app/components/editor-labs/modals/publish-flow/confirm.hbs b/ghost/admin/app/components/editor-labs/modals/publish-flow/confirm.hbs index d00a6de0f2..2f23fc0005 100644 --- a/ghost/admin/app/components/editor-labs/modals/publish-flow/confirm.hbs +++ b/ghost/admin/app/components/editor-labs/modals/publish-flow/confirm.hbs @@ -58,22 +58,6 @@

{{/if}} -{{#if this.emailErrorMessage}} -

- {{svg-jar "warning"}} - - {{#if @publishOptions.willOnlyEmail}} - Your post has been created but the email failed to send. - {{else}} - Your post has been published but the email failed to send. - {{/if}} - - Please verify your email settings if the error persists. -

- Email error: {{this.emailErrorMessage}} -

-{{/if}} -