ghost 6.57.1 → 6.58.0

package/core/server/services/recommendations/service/recommendation-service.ts

@@ -1,285 +0,0 @@
-import errors from '@tryghost/errors';
-import {InMemoryRepository} from '../../lib/in-memory-repository';
-import logging from '@tryghost/logging';
-import tpl from '@tryghost/tpl';
-
-import {IncludeOption, OrderOption} from './bookshelf-repository';
-import {ClickEvent} from './click-event';
-import {AddRecommendation, Recommendation, RecommendationPlain} from './recommendation';
-import {RecommendationRepository} from './recommendation-repository';
-import {SubscribeEvent} from './subscribe-event';
-import {WellknownService} from './well-known-service';
-import {RecommendationMetadataService} from './recommendation-metadata-service';
-
-type MentionSendingService = {
-    sendAll(options: {url: URL, links: URL[]}): Promise<void>
-}
-
-type RecommendationEnablerService = {
-    getSetting(): string,
-    setSetting(value: string): Promise<void>
-}
-
-const messages = {
-    notFound: 'Recommendation with id {id} not found'
-};
-
-export class RecommendationService {
-    repository: RecommendationRepository;
-    clickEventRepository: InMemoryRepository<string, ClickEvent>;
-    subscribeEventRepository: InMemoryRepository<string, SubscribeEvent>;
-
-    wellknownService: WellknownService;
-    mentionSendingService: MentionSendingService;
-    recommendationEnablerService: RecommendationEnablerService;
-    recommendationMetadataService: RecommendationMetadataService;
-
-    constructor(deps: {
-        repository: RecommendationRepository,
-        clickEventRepository: InMemoryRepository<string, ClickEvent>,
-        subscribeEventRepository: InMemoryRepository<string, SubscribeEvent>,
-        wellknownService: WellknownService,
-        mentionSendingService: MentionSendingService,
-        recommendationEnablerService: RecommendationEnablerService,
-        recommendationMetadataService: RecommendationMetadataService
-    }) {
-        this.repository = deps.repository;
-        this.wellknownService = deps.wellknownService;
-        this.mentionSendingService = deps.mentionSendingService;
-        this.recommendationEnablerService = deps.recommendationEnablerService;
-        this.clickEventRepository = deps.clickEventRepository;
-        this.subscribeEventRepository = deps.subscribeEventRepository;
-        this.recommendationMetadataService = deps.recommendationMetadataService;
-    }
-
-    async init() {
-        const recommendations = await this.#listRecommendations();
-        await this.updateWellknown(recommendations);
-
-        // Do a slow update of all the recommendation metadata (keeping logo up to date, one-click-subscribe, etc.)
-        // We better move this to a job in the future
-        if (this.recommendationEnablerService.getSetting() !== 'true') {
-            return;
-        }
-
-        if (!process.env.NODE_ENV?.startsWith('test')) {
-            setTimeout(async () => {
-                try {
-                    await this.updateAllRecommendationsMetadata();
-                } catch (e) {
-                    logging.error('[Recommendations] Failed to update all recommendations metadata on boot', e);
-                }
-            }, 2 * 60 * 1000 + Math.random() * 5 * 60 * 1000);
-        }
-    }
-
-    async updateAllRecommendationsMetadata() {
-        const recommendations = await this.#listRecommendations();
-        logging.info('[Recommendations] Updating recommendations metadata');
-        for (const recommendation of recommendations) {
-            try {
-                await this._updateRecommendationMetadata(recommendation);
-                await this.repository.save(recommendation);
-            } catch (e) {
-                logging.error('[Recommendations] Failed to save updated metadata for recommendation ' + recommendation.url.toString(), e);
-            }
-        }
-    }
-
-    async updateWellknown(recommendations: Recommendation[]) {
-        await this.wellknownService.set(recommendations);
-    }
-
-    async updateRecommendationsEnabledSetting(recommendations: Recommendation[]) {
-        const expectedSetting = (recommendations.length > 0).toString();
-        const currentSetting = this.recommendationEnablerService.getSetting();
-
-        if (currentSetting && currentSetting === expectedSetting) {
-            return;
-        }
-
-        await this.recommendationEnablerService.setSetting(expectedSetting);
-    }
-
-    private sendMentionToRecommendation(recommendation: Recommendation) {
-        this.mentionSendingService.sendAll({
-            url: this.wellknownService.getURL(),
-            links: [
-                recommendation.url
-            ]
-        }).catch((err) => {
-            logging.error('Failed to send mention to recommendation', err);
-        });
-    }
-
-    async readRecommendation(id: string): Promise<RecommendationPlain> {
-        const recommendation = await this.repository.getById(id);
-
-        if (!recommendation) {
-            throw new errors.NotFoundError({
-                message: tpl(messages.notFound, {id})
-            });
-        }
-
-        return recommendation.plain;
-    }
-
-    async addRecommendation(addRecommendation: AddRecommendation): Promise<RecommendationPlain> {
-        const recommendation = Recommendation.create(addRecommendation);
-
-        // If a recommendation with this URL already exists, throw an error
-        const existing = await this.repository.getByUrl(recommendation.url);
-        if (existing) {
-            throw new errors.ValidationError({
-                message: 'A recommendation with this URL already exists.'
-            });
-        }
-
-        await this.repository.save(recommendation);
-
-        const recommendations = await this.#listRecommendations();
-        await this.updateWellknown(recommendations);
-        await this.updateRecommendationsEnabledSetting(recommendations);
-
-        // Only send an update for the mentioned URL
-        this.sendMentionToRecommendation(recommendation);
-        return recommendation.plain;
-    }
-
-    async checkRecommendation(url: URL): Promise<Partial<RecommendationPlain>> {
-        // If a recommendation with this URL already exists, return it, but with updated metadata
-        const existing = await this.repository.getByUrl(url);
-        if (existing) {
-            this._updateRecommendationMetadata(existing);
-            await this.repository.save(existing);
-            return existing.plain;
-        }
-
-        let metadata;
-        try {
-            metadata = await this.recommendationMetadataService.fetch(url);
-        } catch (e) {
-            logging.error('[Recommendations] Failed to fetch metadata for url ' + url, e);
-
-            return {
-                url: url,
-                title: undefined,
-                excerpt: undefined,
-                featuredImage: undefined,
-                favicon: undefined,
-                oneClickSubscribe: false
-            };
-        }
-
-        return {
-            url: url,
-            title: metadata.title ?? undefined,
-            excerpt: metadata.excerpt ?? undefined,
-            featuredImage: metadata.featuredImage ?? undefined,
-            favicon: metadata.favicon ?? undefined,
-            oneClickSubscribe: !!metadata.oneClickSubscribe
-        };
-    }
-
-    async _updateRecommendationMetadata(recommendation: Recommendation) {
-        // Fetch data
-        try {
-            const metadata = await this.recommendationMetadataService.fetch(recommendation.url);
-
-            // Set null values to undefined so we don't trigger an update
-            recommendation.edit({
-                // Don't set title if it's already set on the recommendation
-                title: recommendation.title ? undefined : (metadata.title ?? undefined),
-                excerpt: metadata.excerpt ?? undefined,
-                featuredImage: metadata.featuredImage ?? undefined,
-                favicon: metadata.favicon ?? undefined,
-                oneClickSubscribe: !!metadata.oneClickSubscribe
-            });
-        } catch (e) {
-            logging.error('[Recommendations] Failed to update metadata for recommendation ' + recommendation.url.toString(), e);
-        }
-    }
-
-    async editRecommendation(id: string, recommendationEdit: Partial<Recommendation>): Promise<RecommendationPlain> {
-        // Check if it exists
-        const existing = await this.repository.getById(id);
-        if (!existing) {
-            throw new errors.NotFoundError({
-                message: tpl(messages.notFound, {id})
-            });
-        }
-
-        existing.edit(recommendationEdit);
-        await this._updateRecommendationMetadata(existing);
-        await this.repository.save(existing);
-
-        const recommendations = await this.#listRecommendations();
-        await this.updateWellknown(recommendations);
-
-        this.sendMentionToRecommendation(existing);
-        return existing.plain;
-    }
-
-    async deleteRecommendation(id: string) {
-        const existing = await this.repository.getById(id);
-        if (!existing) {
-            throw new errors.NotFoundError({
-                message: tpl(messages.notFound, {id})
-            });
-        }
-
-        existing.delete();
-        await this.repository.save(existing);
-
-        const recommendations = await this.#listRecommendations();
-        await this.updateWellknown(recommendations);
-        await this.updateRecommendationsEnabledSetting(recommendations);
-
-        // Send a mention (because it was deleted, according to the webmentions spec)
-        this.sendMentionToRecommendation(existing);
-    }
-
-    /**
-     * Sames as listRecommendations, but returns Entities instead of plain objects (Entities are only used internally)
-     */
-    async #listRecommendations(options: { filter?: string; order?: OrderOption<Recommendation>; page?: number; limit?: number|'all', include?: IncludeOption<Recommendation> } = {page: 1, limit: 'all'}): Promise<Recommendation[]> {
-        if (options.limit === 'all') {
-            return await this.repository.getAll({
-                ...options
-            });
-        }
-        return await this.repository.getPage({
-            ...options,
-            page: options.page || 1,
-            limit: options.limit || 15
-        });
-    }
-
-    async listRecommendations(options: { filter?: string; order?: OrderOption<Recommendation>; page?: number; limit?: number|'all', include?: IncludeOption<Recommendation> } = {page: 1, limit: 'all', include: []}): Promise<RecommendationPlain[]> {
-        const list = await this.#listRecommendations(options);
-        return list.map(e => e.plain);
-    }
-
-    async countRecommendations({filter}: { filter?: string }) {
-        return await this.repository.getCount({filter});
-    }
-
-    async trackClicked({id, memberId}: { id: string, memberId?: string }) {
-        const clickEvent = ClickEvent.create({recommendationId: id, memberId});
-        await this.clickEventRepository.save(clickEvent);
-    }
-
-    async trackSubscribed({id, memberId}: { id: string, memberId: string }) {
-        const subscribeEvent = SubscribeEvent.create({recommendationId: id, memberId});
-        await this.subscribeEventRepository.save(subscribeEvent);
-    }
-
-    async readRecommendationByUrl(url: URL): Promise<RecommendationPlain|null> {
-        const recommendation = await this.repository.getByUrl(url);
-
-        if (!recommendation) {
-            return null;
-        }
-        return recommendation.plain;
-    }
-}

package/core/server/services/recommendations/service/recommendation.ts

@@ -1,200 +0,0 @@
-
-import ObjectId from 'bson-objectid';
-import errors from '@tryghost/errors';
-import {UnsafeData} from './unsafe-data';
-
-/**
- * We never expose Entities outside of services. Because we should never expose the bussiness logic methods. The plain objects are used for that
- */
-export type RecommendationPlain = {
-    id: string,
-    title: string
-    description: string|null
-    excerpt: string|null // Fetched from the site meta data
-    featuredImage: URL|null // Fetched from the site meta data
-    favicon: URL|null // Fetched from the site meta data
-    url: URL
-    oneClickSubscribe: boolean,
-    createdAt: Date,
-    updatedAt: Date|null,
-
-    /**
-     * These are read only, you cannot change them
-     */
-    clickCount?: number
-    subscriberCount?: number
-}
-
-export type RecommendationCreateData = {
-    id?: string
-    title: string
-    description: string|null
-    excerpt: string|null // Fetched from the site meta data
-    featuredImage: URL|string|null // Fetched from the site meta data
-    favicon: URL|string|null // Fetched from the site meta data
-    url: URL|string
-    oneClickSubscribe: boolean
-    createdAt?: Date
-    updatedAt?: Date|null,
-
-    /**
-     * These are read only, you cannot change them
-     */
-    clickCount?: number
-    subscriberCount?: number
-}
-
-export type AddRecommendation = Omit<RecommendationCreateData, 'id'|'createdAt'|'updatedAt'>
-export type EditRecommendation = Partial<AddRecommendation>
-
-export class Recommendation {
-    id: string;
-    title: string;
-    description: string|null;
-    excerpt: string|null; // Fetched from the site meta data
-    featuredImage: URL|null; // Fetched from the site meta data
-    favicon: URL|null; // Fetched from the site meta data
-    url: URL;
-    oneClickSubscribe: boolean;
-    createdAt: Date;
-    updatedAt: Date|null;
-    #clickCount: number|undefined;
-    #subscriberCount: number|undefined;
-
-    #deleted: boolean;
-
-    get deleted() {
-        return this.#deleted;
-    }
-
-    get clickCount() {
-        return this.#clickCount;
-    }
-
-    get subscriberCount() {
-        return this.#subscriberCount;
-    }
-
-    private constructor(data: RecommendationPlain) {
-        this.id = data.id;
-        this.title = data.title;
-        this.description = data.description;
-        this.excerpt = data.excerpt;
-        this.featuredImage = data.featuredImage;
-        this.favicon = data.favicon;
-        this.url = data.url;
-        this.oneClickSubscribe = data.oneClickSubscribe;
-        this.createdAt = data.createdAt;
-        this.updatedAt = data.updatedAt;
-        this.#clickCount = data.clickCount;
-        this.#subscriberCount = data.subscriberCount;
-        this.#deleted = false;
-    }
-
-    static validate(properties: AddRecommendation) {
-        if (properties.title.length === 0) {
-            throw new errors.ValidationError({
-                message: 'Title must not be empty'
-            });
-        }
-
-        if (properties.title.length > 2000) {
-            throw new errors.ValidationError({
-                message: 'Title must be less than 2000 characters'
-            });
-        }
-
-        if (properties.description && properties.description.length > 200) {
-            throw new errors.ValidationError({
-                message: 'Description must be less than 200 characters'
-            });
-        }
-    }
-
-    clean() {
-        if (this.description !== null && this.description.length === 0) {
-            this.description = null;
-        }
-
-        if (this.excerpt !== null && this.excerpt.length === 0) {
-            this.excerpt = null;
-        }
-
-        if (this.excerpt !== null && this.excerpt.length > 2000) {
-            this.excerpt = this.excerpt.slice(0, 1997) + '...';
-        }
-
-        this.createdAt.setMilliseconds(0);
-        this.updatedAt?.setMilliseconds(0);
-    }
-
-    static create(data: RecommendationCreateData) {
-        const id = data.id ?? ObjectId().toString();
-
-        const d = {
-            id,
-            title: data.title,
-            description: data.description,
-            excerpt: data.excerpt,
-            featuredImage: new UnsafeData(data.featuredImage, {field: ['featuredImage']}).nullable.url,
-            favicon: new UnsafeData(data.favicon, {field: ['favicon']}).nullable.url,
-            url: new UnsafeData(data.url, {field: ['url']}).url,
-            oneClickSubscribe: data.oneClickSubscribe,
-            createdAt: data.createdAt ?? new Date(),
-            updatedAt: data.updatedAt ?? null,
-            clickCount: data.clickCount,
-            subscriberCount: data.subscriberCount
-        };
-
-        this.validate(d);
-        const recommendation = new Recommendation(d);
-        recommendation.clean();
-
-        return recommendation;
-    }
-
-    get plain(): RecommendationPlain {
-        return {
-            id: this.id,
-            title: this.title,
-            description: this.description,
-            excerpt: this.excerpt,
-            featuredImage: this.featuredImage,
-            favicon: this.favicon,
-            url: this.url,
-            oneClickSubscribe: this.oneClickSubscribe,
-            createdAt: this.createdAt,
-            updatedAt: this.updatedAt,
-            clickCount: this.clickCount,
-            subscriberCount: this.subscriberCount
-        };
-    }
-
-    /**
-     * Change the specified properties. Properties that are set to undefined will not be changed
-     */
-    edit(properties: EditRecommendation) {
-        // Delete undefined properties
-        const newProperties = this.plain;
-        let didChange = false;
-
-        for (const key of Object.keys(properties) as (keyof EditRecommendation)[]) {
-            if (Object.prototype.hasOwnProperty.call(properties, key) && properties[key] !== undefined && properties[key] !== newProperties[key]) {
-                (newProperties as Record<string, unknown>)[key] = properties[key] as unknown;
-                didChange = true;
-            }
-        }
-
-        if (!didChange) {
-            return;
-        }
-        newProperties.updatedAt = new Date();
-
-        const created = Recommendation.create(newProperties);
-        Object.assign(this, created);
-    }
-
-    delete() {
-        this.#deleted = true;
-    }
-}

package/core/server/services/recommendations/service/subscribe-event.ts

@@ -1,32 +0,0 @@
-import ObjectId from 'bson-objectid';
-
-export class SubscribeEvent {
-    id: string;
-    recommendationId: string;
-    memberId: string|null;
-    createdAt: Date;
-
-    get deleted() {
-        return false;
-    }
-
-    private constructor(data: {id: string, recommendationId: string, memberId: string|null, createdAt: Date}) {
-        this.id = data.id;
-        this.recommendationId = data.recommendationId;
-        this.memberId = data.memberId;
-        this.createdAt = data.createdAt;
-    }
-
-    static create(data: {id?: string, recommendationId: string, memberId: string, createdAt?: Date}) {
-        const id = data.id ?? ObjectId().toString();
-
-        const d = {
-            id,
-            recommendationId: data.recommendationId,
-            memberId: data.memberId,
-            createdAt: data.createdAt ?? new Date()
-        };
-
-        return new SubscribeEvent(d);
-    }
-}