Added recommendations data generator

ref PROD-244

ghost/data-generator/lib/importers/RecommendationsImporter.js

@@ -0,0 +1,34 @@
+const TableImporter = require('./TableImporter');
+const {faker} = require('@faker-js/faker');
+
+function capitalize(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+
+class RecommendationsImporter extends TableImporter {
+    static table = 'recommendations';
+    static dependencies = [];
+    defaultQuantity = 15;
+
+    constructor(knex, transaction) {
+        super(RecommendationsImporter.table, knex, transaction);
+    }
+
+    generate() {
+        const id = faker.database.mongodbObjectId();
+        return {
+            id,
+            url: faker.internet.url(),
+            title: capitalize(`${faker.word.adjective()} ${faker.word.noun()}`),
+            excerpt: faker.lorem.sentence(),
+            featured_image: `https://api.dicebear.com/5.x/shapes/png?size=256&seed=${id}`,
+            favicon: `https://api.dicebear.com/5.x/shapes/png?size=32&seed=${id}`,
+            description: faker.lorem.sentence(),
+            one_click_subscribe: faker.datatype.boolean(),
+            created_at: faker.date.past(),
+            updated_at: faker.date.past()
+        };
+    }
+}
+
+module.exports = RecommendationsImporter;

ghost/data-generator/lib/importers/WebMentionsImporter.js

@@ -1,12 +1,11 @@
 const TableImporter = require('./TableImporter');
 const {faker} = require('@faker-js/faker');
-const generateEvents = require('../utils/event-generator');
-const {luck} = require('../utils/random');
 const dateToDatabaseString = require('../utils/database-date');
 
 class WebMentionsImporter extends TableImporter {
     static table = 'mentions';
-    static dependencies = ['posts'];
+    static dependencies = [];
+    defaultQuantity = 3;
 
     constructor(knex, transaction, {baseUrl}) {
         super(WebMentionsImporter.table, knex, transaction);
@@ -14,73 +13,28 @@ class WebMentionsImporter extends TableImporter {
         this.baseUrl = baseUrl;
     }
 
-    async import(quantity) {
-        const posts = await this.transaction.select('id', 'slug', 'published_at').from('posts').where('type', 'post');
-
-        this.quantity = quantity ? quantity / posts.length : 4;
-        await this.importForEach(posts, this.quantity);
-    }
-
-    setReferencedModel(model) {
-        this.model = model;
-
-        // Most web mentions published soon after publication date
-        const startDate = new Date(this.model.published_at);
-        // End date should be either 1 year after post is published, or current date, whichever is first
-        const endDate = new Date(Math.min(new Date().valueOf(), new Date(startDate).setFullYear(startDate.getFullYear() + 1)));
-        this.timestamps = generateEvents({
-            shape: 'ease-out',
-            trend: 'negative',
-            total: this.quantity,
-            startTime: startDate,
-            endTime: endDate
-        }).sort();
-    }
-
     generate() {
-        if (luck(50)) {
-            // 50% chance of 1 mention, 25% chance of 2 mentions, etc.
-            return null;
-        }
-
         const id = faker.database.mongodbObjectId();
-        const timestamp = this.timestamps.shift();
 
         const author = `${faker.name.fullName()}`;
-        /**
+
-        id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+        // Generating only incoming recommendations for now, since we don't use webmentions for other things atm
-        source: {type: 'string', maxlength: 2000, nullable: false},
-        source_title: {type: 'string', maxlength: 2000, nullable: true},
-        source_site_title: {type: 'string', maxlength: 2000, nullable: true},
-        source_excerpt: {type: 'string', maxlength: 2000, nullable: true},
-        source_author: {type: 'string', maxlength: 2000, nullable: true},
-        source_featured_image: {type: 'string', maxlength: 2000, nullable: true},
-        source_favicon: {type: 'string', maxlength: 2000, nullable: true},
-        target: {type: 'string', maxlength: 2000, nullable: false},
-        resource_id: {type: 'string', maxlength: 24, nullable: true},
-        resource_type: {type: 'string', maxlength: 50, nullable: true},
-        created_at: {type: 'dateTime', nullable: false},
-        payload: {type: 'text', maxlength: 65535, nullable: true},
-        deleted: {type: 'boolean', nullable: false, defaultTo: false},
-        verified: {type: 'boolean', nullable: false, defaultTo: false}
-         */
         return {
             id,
-            source: `${faker.internet.url()}/${faker.helpers.slugify(`${faker.word.adjective()} ${faker.word.noun()}`).toLowerCase()}`,
+            source: `${faker.internet.url()}/.well-known/recommendations.json`,
             source_title: faker.lorem.sentence(5),
             source_site_title: `${author}'s ${faker.word.noun()}`,
             source_excerpt: faker.lorem.paragraph(),
             source_author: author,
             source_featured_image: `https://api.dicebear.com/5.x/shapes/png?size=256&seed=${id}`,
             source_favicon: `https://api.dicebear.com/5.x/bottts/png?size=32&seed=${id}`,
-            target: `${this.baseUrl}${this.model.slug}/`,
+            target: `${this.baseUrl}`,
-            resource_id: this.model.id,
+            resource_id: null,
-            resource_type: 'post', // TODO: Randomise resource type - should also include pages
+            resource_type: null,
-            created_at: dateToDatabaseString(timestamp),
+            created_at: dateToDatabaseString(faker.date.past()),
-            payload: JSON.stringify({
+            payload: JSON.stringify({}),
-                // TODO: Add some random payload
+            deleted: 0,
-            }),
+            verified: 1
-            deleted: Math.floor(Math.random() * 2) ? true : false
         };
     }
 }

ghost/data-generator/lib/importers/index.js

@@ -34,5 +34,6 @@ module.exports = [
     require('./LabelsImporter'),
     require('./MembersLabelsImporter'),
     require('./RolesUsersImporter'),
-    require('./MembersFeedbackImporter')
+    require('./MembersFeedbackImporter'),
+    require('./RecommendationsImporter')
 ];