From 5fcf5098a84eea5aed82a412718e6dde8d2b725a Mon Sep 17 00:00:00 2001 From: Fabien 'egg' O'Carroll Date: Thu, 22 Sep 2022 07:39:52 -0400 Subject: [PATCH] Added links API (#15446) closes https://github.com/TryGhost/Team/issues/1927 This expose the /links endpoint on the Admin API, which is filterable by Post ID. Co-authored-by: Simon Backx --- .../admin/app/controllers/posts/analytics.js | 52 +++++++++++++++++++ ghost/admin/app/templates/posts/analytics.hbs | 34 +++++------- ghost/core/core/server/api/endpoints/index.js | 4 ++ ghost/core/core/server/api/endpoints/links.js | 25 +++++++++ .../core/core/server/models/link-redirect.js | 32 ++++++++++++ .../LinkClickRepository.js | 19 ++++++- .../link-click-tracking/PostLinkRepository.js | 36 ++++++++++++- .../services/link-click-tracking/index.js | 11 +++- .../LinkRedirectRepository.js | 34 ++++++++++-- .../server/services/link-redirection/index.js | 7 +-- .../server/web/api/endpoints/admin/routes.js | 3 ++ .../lib/LinkRedirectsService.js | 1 + ghost/link-tracking/lib/FullPostLink.js | 36 +++++++++++++ .../lib/LinkClickTrackingService.js | 18 +++++++ ghost/link-tracking/lib/link-tracking.js | 3 +- 15 files changed, 281 insertions(+), 34 deletions(-) create mode 100644 ghost/core/core/server/api/endpoints/links.js create mode 100644 ghost/link-tracking/lib/FullPostLink.js diff --git a/ghost/admin/app/controllers/posts/analytics.js b/ghost/admin/app/controllers/posts/analytics.js index 90a01eb586ca..cbcbf14a1df6 100644 --- a/ghost/admin/app/controllers/posts/analytics.js +++ b/ghost/admin/app/controllers/posts/analytics.js @@ -13,6 +13,7 @@ export default class AnalyticsController extends Controller { @service ghostPaths; @tracked sources = null; + @tracked links = null; get post() { return this.model; @@ -21,6 +22,7 @@ export default class AnalyticsController extends Controller { @action loadData() { this.fetchReferrersStats(); + this.fetchLinks(); } async fetchReferrersStats() { @@ -30,6 +32,27 @@ export default class AnalyticsController extends Controller { return this._fetchReferrersStats.perform(); } + cleanURL(url, display = false) { + // Remove our own querystring parameters and protocol + const removeParams = ['rel', 'attribution_id', 'attribution_type']; + const urlObj = new URL(url); + for (const param of removeParams) { + urlObj.searchParams.delete(param); + } + if (!display) { + return urlObj.toString(); + } + // Return URL without protocol + return urlObj.host + (urlObj.pathname === '/' ? '' : urlObj.pathname) + (urlObj.search ? '?' + urlObj.search : ''); + } + + async fetchLinks() { + if (this._fetchLinks.isRunning) { + return this._fetchLinks.last; + } + return this._fetchLinks.perform(); + } + @task *_fetchReferrersStats() { let statsUrl = this.ghostPaths.url.api(`stats/referrers/posts/${this.post.id}`); @@ -42,4 +65,33 @@ export default class AnalyticsController extends Controller { }; }); } + + @task + *_fetchLinks() { + const filter = `post_id:${this.post.id}`; + let statsUrl = this.ghostPaths.url.api(`links/`) + `?filter=${encodeURIComponent(filter)}`; + let result = yield this.ajax.request(statsUrl); + const links = result.links.map((link) => { + return { + ...link, + link: { + ...link.link, + to: this.cleanURL(link.link.to, false), + title: this.cleanURL(link.link.to, true) + } + }; + }); + + // Remove duplicates by title ad merge + const linksByTitle = links.reduce((acc, link) => { + if (!acc[link.link.title]) { + acc[link.link.title] = link; + } else { + acc[link.link.title].clicks += link.clicks; + } + return acc; + }, {}); + + this.links = Object.values(linksByTitle); + } } diff --git a/ghost/admin/app/templates/posts/analytics.hbs b/ghost/admin/app/templates/posts/analytics.hbs index 4c5a06c51e6c..0187c379b21d 100644 --- a/ghost/admin/app/templates/posts/analytics.hbs +++ b/ghost/admin/app/templates/posts/analytics.hbs @@ -1,4 +1,4 @@ -
+
@@ -61,32 +61,24 @@
+ {{#if (and this.links this.links.length) }}

Link clicks

-
-
-
- https://vanschneider.com/blog/#/portal/signup -

18

-
-
- https://vanschneider.com/blog/an-unsolicited-portfolio-review-featuring-2/ -

16

-
-
- https://vanschneider.com/blog/#/portal/unsubscribe -

3

-
-
- https://vanschneider.com/blog/#/portal/signin -

0

+
+
+ {{#each this.links as |link|}} +
+ {{link.link.title}} +

{{link.count.clicks}}

+
+ {{/each}}
-
+ {{/if}} - {{#if (feature 'sourceAttribution')}} -

+ {{#if (and (feature 'sourceAttribution') this.sources this.sources.length)}} +

Source attribution

{{#if this.sources}} diff --git a/ghost/core/core/server/api/endpoints/index.js b/ghost/core/core/server/api/endpoints/index.js index 5b2fc5cba74b..01c8bae78e79 100644 --- a/ghost/core/core/server/api/endpoints/index.js +++ b/ghost/core/core/server/api/endpoints/index.js @@ -185,6 +185,10 @@ module.exports = { return apiFramework.pipeline(require('./comments'), localUtils); }, + get links() { + return apiFramework.pipeline(require('./links'), localUtils); + }, + /** * Content API Controllers * diff --git a/ghost/core/core/server/api/endpoints/links.js b/ghost/core/core/server/api/endpoints/links.js new file mode 100644 index 000000000000..d9938cec24d6 --- /dev/null +++ b/ghost/core/core/server/api/endpoints/links.js @@ -0,0 +1,25 @@ +const linkTrackingService = require('../../services/link-click-tracking'); + +module.exports = { + docName: 'links', + browse: { + options: [ + 'filter' + ], + permissions: false, + async query(frame) { + const links = await linkTrackingService.service.getLinks(frame.options); + + return { + data: links, + meta: { + pagination: { + total: links.length, + page: 1, + pages: 1 + } + } + }; + } + } +}; diff --git a/ghost/core/core/server/models/link-redirect.js b/ghost/core/core/server/models/link-redirect.js index eef3cd97bdd9..0f4f17e95f5e 100644 --- a/ghost/core/core/server/models/link-redirect.js +++ b/ghost/core/core/server/models/link-redirect.js @@ -26,6 +26,38 @@ const LinkRedirect = ghostBookshelf.Model.extend({ return attrs; } }, { + orderDefaultRaw(options) { + if (options.withRelated && options.withRelated.includes('count.clicks')) { + return '`count__clicks` DESC, `to` DESC'; + } + return '`to` DESC'; + }, + + permittedOptions(methodName) { + let options = ghostBookshelf.Model.permittedOptions.call(this, methodName); + const validOptions = { + findAll: ['filter', 'columns', 'withRelated'] + }; + + if (validOptions[methodName]) { + options = options.concat(validOptions[methodName]); + } + + return options; + }, + + countRelations() { + return { + clicks(modelOrCollection) { + modelOrCollection.query('columns', 'link_redirects.*', (qb) => { + qb.countDistinct('members_link_click_events.member_id') + .from('members_link_click_events') + .whereRaw('link_redirects.id = members_link_click_events.link_id') + .as('count__clicks'); + }); + } + }; + } }); module.exports = { diff --git a/ghost/core/core/server/services/link-click-tracking/LinkClickRepository.js b/ghost/core/core/server/services/link-click-tracking/LinkClickRepository.js index 95b76a0b032d..cd9e9022b98f 100644 --- a/ghost/core/core/server/services/link-click-tracking/LinkClickRepository.js +++ b/ghost/core/core/server/services/link-click-tracking/LinkClickRepository.js @@ -1,3 +1,4 @@ +const {LinkClick} = require('@tryghost/link-tracking'); const ObjectID = require('bson-objectid').default; module.exports = class LinkClickRepository { @@ -17,8 +18,24 @@ module.exports = class LinkClickRepository { this.#Member = deps.Member; } + async getAll(options) { + const collection = await this.#MemberLinkClickEvent.findAll(options); + + const result = []; + + for (const model of collection.models) { + const member = await this.#Member.findOne({id: model.get('member_id')}); + result.push(new LinkClick({ + link_id: model.get('link_id'), + member_uuid: member.get('uuid') + })); + } + + return result; + } + /** - * @param {import('@tryghost/link-tracking').LinkClick} linkClick + * @param {LinkClick} linkClick * @returns {Promise} */ async save(linkClick) { diff --git a/ghost/core/core/server/services/link-click-tracking/PostLinkRepository.js b/ghost/core/core/server/services/link-click-tracking/PostLinkRepository.js index 702d080b0783..46c08ba93ada 100644 --- a/ghost/core/core/server/services/link-click-tracking/PostLinkRepository.js +++ b/ghost/core/core/server/services/link-click-tracking/PostLinkRepository.js @@ -1,21 +1,55 @@ +const {FullPostLink} = require('@tryghost/link-tracking'); + /** * @typedef {import('bson-objectid').default} ObjectID + * @typedef {import('@tryghost/link-tracking/lib/PostLink')} PostLink */ module.exports = class PostLinkRepository { /** @type {Object} */ #LinkRedirect; + /** @type {Object} */ + #linkRedirectRepository; /** * @param {object} deps * @param {object} deps.LinkRedirect Bookshelf Model + * @param {object} deps.linkRedirectRepository Bookshelf Model */ constructor(deps) { this.#LinkRedirect = deps.LinkRedirect; + this.#linkRedirectRepository = deps.linkRedirectRepository; + } + + /** + * + * @param {*} options + * @returns {Promise[]>} + */ + async getAll(options) { + const collection = await this.#LinkRedirect.findAll({...options, withRelated: ['count.clicks']}); + + const result = []; + + for (const model of collection.models) { + const link = this.#linkRedirectRepository.fromModel(model); + + result.push( + new FullPostLink({ + post_id: model.get('post_id'), + link, + count: { + clicks: model.get('count__clicks') + } + }) + ); + } + + return result; } /** - * @param {import('@tryghost/link-tracking/lib/PostLink')} postLink + * @param {PostLink} postLink * @returns {Promise} */ async save(postLink) { diff --git a/ghost/core/core/server/services/link-click-tracking/index.js b/ghost/core/core/server/services/link-click-tracking/index.js index 818df7e1b4f7..9a1ff4f04cf5 100644 --- a/ghost/core/core/server/services/link-click-tracking/index.js +++ b/ghost/core/core/server/services/link-click-tracking/index.js @@ -1,5 +1,6 @@ const LinkClickRepository = require('./LinkClickRepository'); const PostLinkRepository = require('./PostLinkRepository'); +const errors = require('@tryghost/errors'); class LinkTrackingServiceWrapper { async init() { @@ -8,12 +9,18 @@ class LinkTrackingServiceWrapper { return; } + const linkRedirection = require('../link-redirection'); + if (!linkRedirection.service) { + throw new errors.InternalServerError({message: 'LinkRedirectionService should be initialised before LinkTrackingService'}); + } + // Wire up all the dependencies const models = require('../../models'); const {LinkTrackingService} = require('@tryghost/link-tracking'); const postLinkRepository = new PostLinkRepository({ - LinkRedirect: models.LinkRedirect + LinkRedirect: models.LinkRedirect, + linkRedirectRepository: linkRedirection.linkRedirectRepository }); const linkClickRepository = new LinkClickRepository({ @@ -23,7 +30,7 @@ class LinkTrackingServiceWrapper { // Expose the service this.service = new LinkTrackingService({ - linkRedirectService: require('../link-redirection').service, + linkRedirectService: linkRedirection.service, linkClickRepository, postLinkRepository }); diff --git a/ghost/core/core/server/services/link-redirection/LinkRedirectRepository.js b/ghost/core/core/server/services/link-redirection/LinkRedirectRepository.js index 10287fa09500..8b570ea49d26 100644 --- a/ghost/core/core/server/services/link-redirection/LinkRedirectRepository.js +++ b/ghost/core/core/server/services/link-redirection/LinkRedirectRepository.js @@ -4,13 +4,17 @@ const ObjectID = require('bson-objectid').default; module.exports = class LinkRedirectRepository { /** @type {Object} */ #LinkRedirect; + /** @type {Object} */ + #urlUtils; /** * @param {object} deps * @param {object} deps.LinkRedirect Bookshelf Model + * @param {object} deps.urlUtils */ constructor(deps) { this.#LinkRedirect = deps.LinkRedirect; + this.#urlUtils = deps.urlUtils; } /** @@ -27,6 +31,30 @@ module.exports = class LinkRedirectRepository { linkRedirect.link_id = ObjectID.createFromHexString(model.id); } + #trimLeadingSlash(url) { + return url.replace(/^\//, ''); + } + + fromModel(model) { + return new LinkRedirect({ + id: model.id, + from: new URL(this.#trimLeadingSlash(model.get('from')), this.#urlUtils.urlFor('home', true)), + to: new URL(model.get('to')) + }); + } + + async getAll(options) { + const collection = await this.#LinkRedirect.findAll(options); + + const result = []; + + for (const model of collection.models) { + result.push(this.fromModel(model)); + } + + return result; + } + /** * * @param {URL} url @@ -40,11 +68,7 @@ module.exports = class LinkRedirectRepository { }, {}); if (linkRedirect) { - return new LinkRedirect({ - id: linkRedirect.id, - from: url, - to: new URL(linkRedirect.get('to')) - }); + return this.fromModel(linkRedirect); } } }; diff --git a/ghost/core/core/server/services/link-redirection/index.js b/ghost/core/core/server/services/link-redirection/index.js index 7eba3c113445..4fcfe0286871 100644 --- a/ghost/core/core/server/services/link-redirection/index.js +++ b/ghost/core/core/server/services/link-redirection/index.js @@ -13,13 +13,14 @@ class LinkRedirectsServiceWrapper { const {LinkRedirectsService} = require('@tryghost/link-redirects'); - const linkRedirectRepository = new LinkRedirectRepository({ - LinkRedirect: models.LinkRedirect + this.linkRedirectRepository = new LinkRedirectRepository({ + LinkRedirect: models.LinkRedirect, + urlUtils }); // Expose the service this.service = new LinkRedirectsService({ - linkRedirectRepository, + linkRedirectRepository: this.linkRedirectRepository, config: { baseURL: new URL(urlUtils.getSiteUrl()) } diff --git a/ghost/core/core/server/web/api/endpoints/admin/routes.js b/ghost/core/core/server/web/api/endpoints/admin/routes.js index adf208a56bb4..34e23ce13bba 100644 --- a/ghost/core/core/server/web/api/endpoints/admin/routes.js +++ b/ghost/core/core/server/web/api/endpoints/admin/routes.js @@ -3,6 +3,7 @@ const api = require('../../../../api').endpoints; const {http} = require('@tryghost/api-framework'); const apiMw = require('../../middleware'); const mw = require('./middleware'); +const labs = require('../../../../../shared/labs'); const shared = require('../../../shared'); @@ -309,5 +310,7 @@ module.exports = function apiRoutes() { router.put('/newsletters/verifications/', mw.authAdminApi, http(api.newsletters.verifyPropertyUpdate)); router.put('/newsletters/:id', mw.authAdminApi, http(api.newsletters.edit)); + router.get('/links', labs.enabledMiddleware('emailClicks'), mw.authAdminApi, http(api.links.browse)); + return router; }; diff --git a/ghost/link-redirects/lib/LinkRedirectsService.js b/ghost/link-redirects/lib/LinkRedirectsService.js index cc57c0274107..70e00366574d 100644 --- a/ghost/link-redirects/lib/LinkRedirectsService.js +++ b/ghost/link-redirects/lib/LinkRedirectsService.js @@ -6,6 +6,7 @@ const LinkRedirect = require('./LinkRedirect'); /** * @typedef {object} ILinkRedirectRepository * @prop {(url: URL) => Promise} getByURL + * @prop {({filter: string}) => Promise} getAll * @prop {(linkRedirect: LinkRedirect) => Promise} save */ diff --git a/ghost/link-tracking/lib/FullPostLink.js b/ghost/link-tracking/lib/FullPostLink.js new file mode 100644 index 000000000000..67ca6cb83b76 --- /dev/null +++ b/ghost/link-tracking/lib/FullPostLink.js @@ -0,0 +1,36 @@ +const ObjectID = require('bson-objectid').default; + +/** + * @typedef {Object} FullPostLinkCount + * @property {number} clicks + */ + +/** + * Stores the connection between a LinkRedirect and a Post + */ +module.exports = class FullPostLink { + /** @type {ObjectID} */ + post_id; + + /** @type {import('@tryghost/link-redirects/lib/LinkRedirect')} */ + link; + + /** @type {FullPostLinkCount} */ + count; + + /** + * @param {object} data + * @param {string|ObjectID} data.post_id + * @param {import('@tryghost/link-redirects/lib/LinkRedirect')} data.link + * @param {FullPostLinkCount} data.count + */ + constructor(data) { + if (typeof data.post_id === 'string') { + this.post_id = ObjectID.createFromHexString(data.post_id); + } else { + this.post_id = data.post_id; + } + this.link = data.link; + this.count = data.count; + } +}; diff --git a/ghost/link-tracking/lib/LinkClickTrackingService.js b/ghost/link-tracking/lib/LinkClickTrackingService.js index f483dcf837cb..6ee8424b147d 100644 --- a/ghost/link-tracking/lib/LinkClickTrackingService.js +++ b/ghost/link-tracking/lib/LinkClickTrackingService.js @@ -7,6 +7,7 @@ const ObjectID = require('bson-objectid').default; /** * @typedef {object} ILinkClickRepository * @prop {(event: LinkClick) => Promise} save + * @prop {({filter: string}) => Promise} getAll */ /** @@ -16,10 +17,15 @@ const ObjectID = require('bson-objectid').default; * @prop {URL} from */ +/** + * @typedef {import('./FullPostLink')} FullPostLink + */ + /** * @typedef {object} ILinkRedirectService * @prop {(to: URL, slug: string) => Promise} addRedirect * @prop {() => Promise} getSlug + * @prop {({filter: string}) => Promise} getAll */ /** @@ -30,6 +36,7 @@ const ObjectID = require('bson-objectid').default; /** * @typedef {object} IPostLinkRepository * @prop {(postLink: PostLink) => Promise} save + * @prop {({filter: string}) => Promise} getAll */ class LinkClickTrackingService { @@ -62,6 +69,17 @@ class LinkClickTrackingService { this.#initialised = true; } + /** + * @param {object} options + * @param {string} options.filter + * @return {Promise} + */ + async getLinks(options) { + return await this.#postLinkRepository.getAll({ + filter: options.filter + }); + } + /** * Replace URL with a redirect that redirects to the original URL, and link that redirect with the given post */ diff --git a/ghost/link-tracking/lib/link-tracking.js b/ghost/link-tracking/lib/link-tracking.js index 371376c6ab54..8fddfe73bdb6 100644 --- a/ghost/link-tracking/lib/link-tracking.js +++ b/ghost/link-tracking/lib/link-tracking.js @@ -1,5 +1,6 @@ module.exports = { LinkTrackingService: require('./LinkClickTrackingService'), LinkClick: require('./LinkClick'), - PostLink: require('./PostLink') + PostLink: require('./PostLink'), + FullPostLink: require('./FullPostLink') };