Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-03-11 02:12:21 -05:00
Code Issues Activity

Added basic email debug design (#15914)

Browse source 
refs https://github.com/TryGhost/Team/issues/2327

As part of improving visibility for email failures, this change adds a new debug screen that allows visualising the email failures for a post. The screen is hidden on the UI for now and only accessible via URL directly.

Co-authored-by: Djordje Vlaisavljevic <dzvlais@gmail.com>
This commit is contained in:
Rishabh Garg 2022-12-01 17:58:37 +05:30 • committed by GitHub
parent 12219fed65
commit a5ca64f693
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 184 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
ghost/admin/app/router.js
View file

@ -30,6 +30,7 @@ Router.map(function () {
this.route('posts');
this.route('posts.analytics', {path: '/posts/analytics/:post_id'});
this.route('posts.debug', {path: '/posts/analytics/:post_id/debug'});
this.route('pages');

53
ghost/admin/app/routes/posts/debug.js Normal file
View file

@ -0,0 +1,53 @@
import AuthenticatedRoute from 'ghost-admin/routes/authenticated';
import {pluralize} from 'ember-inflector';
export default class Debug extends AuthenticatedRoute {
model(params) {
let {post_id: id} = params;
let query = {
id,
include: [
'tags',
'authors',
'authors.roles',
'email',
'tiers',
'newsletter',
'count.conversions',
'count.clicks',
'sentiment',
'count.positive_feedback',
'count.negative_feedback'
].join(',')
};
return this.store.query('post', query)
.then(records => records.get('firstObject'));
}
// the API will return a post even if the logged in user doesn't have
// permission to edit it (all posts are public) so we need to do our
// own permissions check and redirect if necessary
afterModel(post) {
super.afterModel(...arguments);
const user = this.session.user;
const returnRoute = pluralize(post.constructor.modelName);
if (user.isAuthorOrContributor && !post.isAuthoredByUser(user)) {
return this.replaceWith(returnRoute);
}
// If the post is not a draft and user is contributor, redirect to index
if (user.isContributor && !post.isDraft) {
return this.replaceWith(returnRoute);
}
}
serialize(model) {
return {
post_id: model.id
};
}
}

130
ghost/admin/app/templates/posts/debug.hbs Normal file
View file

@ -0,0 +1,130 @@
<section class="gh-canvas {{if (feature "audienceFeedback") "feature-audienceFeedback"}}" {{did-insert this.loadData}}>
<GhCanvasHeader class="gh-canvas-header gh-post-analytics-header">
<div class="flex flex-column flex-grow-1">
<div class="gh-canvas-breadcrumb">
<LinkTo @route="posts">
Posts
</LinkTo>
{{svg-jar "arrow-right-small"}}Analytics
</div>
<h2 class="gh-canvas-title gh-post-title">
Post title
</h2>
<div class="gh-post-analytics-meta">
<div class="gh-post-analytics-meta-text">
{{#if this.post.hasBeenEmailed }}
{{#if this.post.emailOnly}}
Sent
{{else}}
Published and sent
{{/if}}
{{else}}
Published
{{#if @post.didEmailFail}}
but failed to send
{{else}}
on your site
{{/if}}
{{/if}}
{{#let (moment-site-tz this.post.publishedAtUTC) as |publishedAt|}}
on
{{moment-format publishedAt "D MMM YYYY"}}
at
{{moment-format publishedAt "HH:mm"}}
{{/let}}
</div>
</div>
<div class="gh-box gh-box-error gh-box-tip flex justify-between">
{{svg-jar "warning"}}
<div>
<h4>Major error</h4>
<p class="mb0">This is the explanation of what happened.</p>
</div>
<button type="button" class="gh-btn gh-btn-primary gh-btn-icon gh-btn-red ember-view self-center"><span>Retry</span></button>
</div>
</div>
</GhCanvasHeader>
<Tabs::Tabs class="gh-tabs-analytics" @forceRender={{true}} as |tabs|>
<tabs.tab>
<h3>{{svg-jar "analytics-tab-sent-large"}}23</h3>
<p><span class="analytics-tab-label">Permanent failures</span></p>
</tabs.tab>
<tabs.tabPanel>
<div class="gh-post-activity-feed">
<div class="gh-dashboard-list-body">
<div class="gh-dashboard-list-body gh-dashboard-list-cols-3">
<div class="gh-dashboard-list-item" style="grid-template-columns:30% 70%;">
<div class="gh-dashboard-list-item-sub">
<figure class="gh-member-gravatar w9 h9 mr3 flex-shrink-0 bg-red">
<div class="gh-member-initials flex w9 h9 items-center justify-center br-100">
<span class="gh-member-avatar-label gh-member-list-avatar">NN</span>
</div>
{{#if this.avatarImage}}
<img class="gh-member-avatar-image" src="{{this.avatarImage}}" alt="{{or @member.name @member.email}}" />
{{/if}}
</figure>
<div class="">
<h3 class="ma0 pa0 gh-members-list-name">Name Lastname</h3>
<p class="ma0 pa0 middarkgrey f8 gh-members-list-email">dzvlais@gmail.com</p>
</div>
</div>
<div class="gh-dashboard-list-item-sub">
{{svg-jar "warning-stroke"}}
<span class="gh-dashboard-list-subtext">
<span class="gh-members-activity-description">
<span class="gh-members-activity-event-text">402</span>
<p>4.2.2 The email account that you tried to reach is over quota. Please direct\n4.2.2 the recipient to\n4.2.2 https://support.google.com/mail/?p=OverQuotaTemp bb1-20020a05622a1b0100b0039ce87e3d49si1009300qtb.292 - gsmtp</p>
</span>
</span>
</div>
</div>
</div>
</div>
</div>
</tabs.tabPanel>
<tabs.tab>
<h3>{{svg-jar "analytics-tab-opened-large"}}36</h3>
<p><span class="analytics-tab-label">Temporary failures</span></p>
</tabs.tab>
<tabs.tabPanel>
<Posts::PostActivityFeed
@postId={{this.post.id}}
@eventType="opened"
@linkQuery={{hash filterParam=(concat "opened_emails.post_id:" this.post.id) }}
/>
</tabs.tabPanel>
<tabs.tab>
<h3>{{svg-jar "analytics-tab-clicked-large"}}3</h3>
<p><span class="analytics-tab-label">Batches errored</span></p>
</tabs.tab>
<tabs.tabPanel>
<Posts::PostActivityFeed
@postId={{this.post.id}}
@eventType="clicked"
@linkQuery={{hash filterParam=(concat "clicked_links.post_id:" this.post.id) }}
/>
</tabs.tabPanel>
<tabs.tab>
<h3>{{svg-jar "settings"}}{{format-number this.totalFeedback}}</h3>
<p><span class="analytics-tab-label">Settings</span></p>
</tabs.tab>
<tabs.tabPanel>
<Posts::PostActivityFeed
@postId={{this.post.id}}
@eventType="feedback"
@data={{this.feedbackChartData}}
/>
</tabs.tabPanel>
</Tabs::Tabs>
</section>