🔨 ✨ [Chore][ISSUE-3] Add CMS Seed Data generation (#5)

- use strapi bootstrap for development seeding
- add generateSeedData to bootstrap function
- add _seed data with implementation for: projects & contributors / users / partners
- add yarn seed to package.json
- update README.md with relevant info for seeding
- update .env.example with dummy values for api keys and tokens
- add DEV_* value defaults for seed data generation

Author: andriishupta

cms/.env.example

@@ -1,12 +1,17 @@
 HOST=0.0.0.0
 PORT=1337
 APP_KEYS=value_1,value_2,value_3
-API_TOKEN_SALT=
-ADMIN_JWT_SECRET=
-JWT_SECRET=
+API_TOKEN_SALT=API_TOKEN_SALT_VALUE
+ADMIN_JWT_SECRET=ADMIN_JWT_SECRET_VALUE
+JWT_SECRET=__SKIP_FOR_LOCAL_ENVIRONMENT--GENERATED__
 
 DATABASE_HOST=
 DATABASE_PORT=
 DATABASE_NAME=
 DATABASE_USERNAME=
 DATABASE_PASSWORD=
+
+
+DEV_SEED_DATA_PROJECTS=8
+DEV_SEED_DATA_CONTRIBUTORS=15
+DEV_SEED_DATA_PARTNERS=5

cms/README.md

@@ -1,24 +1,50 @@
-# 🚀 Getting started with Strapi
+# DeveloperDAO.com CMS
 
-Strapi comes with a full featured [Command Line Interface](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html) (CLI) which lets you scaffold and manage your project in seconds.
+## Development
+
+### Prerequisites
+
+create `.env` from `.env.example` and remove `JWT_SECRET` such as it would be generated and added to `.env` file by Strapi
 
 ### `develop`
 
 Start your Strapi application with autoReload enabled. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-develop)
 
 ```
-npm run develop
-# or
 yarn develop
 ```
 
+### `seed`
+
+By default, on the first application _DEVELOPMENT_ start(with `yarn develop`), **seed data** would be generated. In case you need to re-create it, run
+
+```
+yarn seed
+```
+
+> ⚠️ This will clear all data from all available collections
+
+#### How it works?
+
+Strapi runs **bootstrap** function from `/src/index.js` [every time on server start](https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/configurations/optional/functions.html#bootstrap).
+
+On the initial run, we check if the current mode is _development_ to run `generateSeedData` function. Only if we previously haven't run seeding - we run it.
+
+When manual seeding happens with `FORCE_APP_BOOTSTRAP_ONLY` in _development_ mode, we run `strapi start` and exit right after **bootstrap** is finished.
+In this case, we could have our main app running and not worry about the "port is used" error.
+
+There are default values of how much data we want to generate - feel free to increase or make them 0.
+```
+DEV_SEED_DATA_PROJECTS=8
+DEV_SEED_DATA_CONTRIBUTORS=15
+DEV_SEED_DATA_PARTNERS=5
+```
+
 ### `start`
 
 Start your Strapi application with autoReload disabled. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-start)
 
 ```
-npm run start
-# or
 yarn start
 ```
 
@@ -27,11 +53,15 @@ yarn start
 Build your admin panel. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-build)
 
 ```
-npm run build
-# or
 yarn build
 ```
 
+---
+
+# Strapi
+
+Strapi comes with a full featured [Command Line Interface](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html) (CLI) which lets you scaffold and manage your project in seconds.
+
 ## ⚙️ Deployment
 
 Strapi gives you many possible deployment options for your project. Find the one that suits you on the [deployment section of the documentation](https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/deployment.html).
@@ -51,7 +81,3 @@ Feel free to check out the [Strapi GitHub repository](https://github.com/strapi/
 - [Discord](https://discord.strapi.io) - Come chat with the Strapi community including the core team.
 - [Forum](https://forum.strapi.io/) - Place to discuss, ask questions and find answers, show your Strapi project and get feedback or just talk with other Community members.
 - [Awesome Strapi](https://github.com/strapi/awesome-strapi) - A curated list of awesome things related to Strapi.
-
----
-
-<sub>🤫 Psst! [Strapi is hiring](https://strapi.io/careers).</sub>

cms/package.json

@@ -8,9 +8,12 @@
     "develop-pg": "NODE_ENV=pg strapi develop",
     "start": "NODE_ENV=production strapi start",
     "build": "NODE_ENV=production strapi build",
+    "seed": "FORCE_APP_BOOTSTRAP_ONLY=true NODE_ENV=development strapi start",
     "strapi": "strapi"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "@faker-js/faker": "^7.3.0"
+  },
   "dependencies": {
     "@strapi/plugin-graphql": "4.2.2",
     "@strapi/plugin-i18n": "4.2.2",

cms/src/_seed/constants.js

@@ -0,0 +1,8 @@
+module.exports = {
+  SEED_USERNAME: 'seed_user',
+  APPLICATION_COLLECTION_TYPE_UIDS: [
+    'api::contributor.contributor',
+    'api::partner.partner',
+    'api::project.project',
+  ],
+}

cms/src/_seed/helpers.js

@@ -0,0 +1,55 @@
+const { APPLICATION_COLLECTION_TYPE_UIDS } = require('./constants');
+
+/**
+ * @param {Strapi} strapi
+ */
+const ensureSQLite = (strapi) => {
+  console.log('verifying db as local SQLite')
+  if (strapi.db.config.connection.client !== 'sqlite') {
+    throw new Error('strapi is NOT using local SQLite! Please, verify usage of SQLite before clearing data')
+  }
+}
+
+const randomBoolean = () => Math.random() < 0.5
+
+/**
+ * @param {Strapi} strapi
+ * @returns {Promise<void>}
+ */
+const clearData = async (strapi) => {
+  ensureSQLite(strapi)
+
+  const collectionTypeUids = [...APPLICATION_COLLECTION_TYPE_UIDS, 'plugin::users-permissions.user']
+  const bulkClears = []
+
+  for (const collectionTypeUid of collectionTypeUids) {
+    const collectionClear = strapi.query(collectionTypeUid).deleteMany({
+      where: {
+        id: {
+          $notNull: true,
+        },
+      },
+    });
+
+    bulkClears.push(collectionClear)
+  }
+
+  await Promise.all(bulkClears)
+}
+
+const sampleSize = (arr, num = Math.floor(Math.random() * arr.length)) => {
+  if (!arr || arr.length === 0) {
+    throw new Error('[sampleSize] valid arr is mandatory!')
+  }
+
+  const shuffled = [...arr].sort(() => 0.5 - Math.random());
+
+  return shuffled.slice(0, num);
+}
+
+module.exports = {
+  ensureSQLite,
+  randomBoolean,
+  clearData,
+  sampleSize
+}

cms/src/_seed/index.js

@@ -0,0 +1,43 @@
+const { seedUserExists, generateUserData } = require('./user');
+const { clearData } = require('./helpers');
+const { generatePartnerData } = require('./partner');
+const { generateProjectAndContributorData } = require('./project-and-contributor');
+
+/**
+ * @param {Strapi} strapi
+ * @returns {Promise<void>}
+ */
+const generateSeedData = async (strapi) => {
+  const dataExists = await seedUserExists(strapi)
+  const forceBootstrap = process.env.FORCE_APP_BOOTSTRAP_ONLY === 'true'
+
+  const skipGeneration = dataExists && !forceBootstrap
+
+  if (skipGeneration) {
+    console.log('skipping seed data generation...')
+    return
+  }
+
+  if (forceBootstrap) {
+    console.log('forcing seed data re-creation...')
+    await clearData(strapi)
+    console.log('existing data has been cleaned!')
+  }
+
+  console.log('generating seed data...')
+
+  await Promise.all([
+    generateProjectAndContributorData(strapi),
+    generatePartnerData(strapi),
+    generateUserData(strapi)
+  ]).catch(e => {
+    console.error('error during generating seed data! Stopping the application...')
+    throw new Error(e)
+  })
+
+  console.log('generating seed data has been finished successfully!')
+}
+
+module.exports = {
+  generateSeedData
+}

cms/src/_seed/partner.js

@@ -0,0 +1,40 @@
+const { faker } = require('@faker-js/faker');
+const { randomBoolean } = require('./helpers');
+
+/**
+ * @param {Strapi} strapi
+ * @returns {Promise<void>}
+ */
+const generatePartnerData = async (strapi) => {
+  console.log('generating partners')
+
+  const { DEV_SEED_DATA_PARTNERS } = process.env
+  const partnersSize = DEV_SEED_DATA_PARTNERS ? parseInt(DEV_SEED_DATA_PARTNERS) : 5
+
+  const bulkPartnerPromises = []
+  const randomPartnersData = new Array(partnersSize).fill(null).map(_randomPartner)
+
+  for (const randomPartnerData of randomPartnersData) {
+    const randomPartnerPromise = strapi.entityService.create('api::partner.partner', { data: randomPartnerData })
+    bulkPartnerPromises.push(randomPartnerPromise)
+  }
+
+  await Promise.all(bulkPartnerPromises)
+}
+
+const _randomPartner = () => ({
+  name: faker.company.companyName(),
+  website: faker.internet.url(),
+  twitter_handle: faker.internet.userName().toLowerCase(),
+  publishedAt: randomBoolean() ? new Date().toISOString() : null
+  /**
+   * "Media Library Upload" is only working via RestAPI, but when we generate seed data, no server is running
+   * Skipping logos generation so far
+   */
+  // logo_dark
+  // logo_light
+})
+
+module.exports = {
+  generatePartnerData
+}

cms/src/_seed/project-and-contributor.js

@@ -0,0 +1,71 @@
+const { faker } = require('@faker-js/faker');
+const { randomBoolean, sampleSize } = require('./helpers');
+/**
+ * @param {Strapi} strapi
+ * @returns {Promise<void>}
+ */
+const generateProjectAndContributorData = async (strapi) => {
+  console.log(`generating projects and contributors`)
+
+  const { DEV_SEED_DATA_PROJECTS, DEV_SEED_DATA_CONTRIBUTORS } = process.env
+  const projectsSize = DEV_SEED_DATA_PROJECTS ? parseInt(DEV_SEED_DATA_PROJECTS) : 8
+  const contributorsSize = DEV_SEED_DATA_CONTRIBUTORS ? parseInt(DEV_SEED_DATA_CONTRIBUTORS) : 15
+
+  const bulkProjectPromises = []
+  const bulkContributorPromises = []
+
+  const randomProjectsData = new Array(projectsSize).fill(null).map(_randomProject)
+  const randomContributorsData = new Array(contributorsSize).fill(null).map(_randomContributor)
+
+  for (const randomProjectData of randomProjectsData) {
+    const randomProjectPromise = strapi.entityService.create('api::project.project', { data: randomProjectData })
+    bulkProjectPromises.push(randomProjectPromise)
+  }
+
+  const projects = await Promise.all(bulkProjectPromises)
+
+  for (const randomContributorData of randomContributorsData) {
+    const addProject = randomBoolean()
+
+    const randomContributorPromise = strapi.entityService.create('api::contributor.contributor', {
+      data: {
+        ...randomContributorData,
+        ...addProject ? ({ projects: sampleSize(projects).map(project => project.id) }) : {}
+      }
+    })
+    bulkContributorPromises.push(randomContributorPromise)
+  }
+
+  await Promise.all(bulkContributorPromises)
+}
+
+const _randomProject = () => {
+  const username = faker.internet.userName().toLowerCase()
+
+  return {
+    name: faker.company.companyName(),
+    hero_image: faker.image.avatar(),
+    description_short: faker.company.bs(),
+    description_long: faker.lorem.paragraph(),
+    ens_name: `${ username }.eth`,
+    website: faker.internet.url(),
+    twitter_handle: username,
+    publishedAt: randomBoolean() ? new Date().toISOString() : null
+  }
+}
+
+const _randomContributor = () => {
+  const username = faker.internet.userName().toLowerCase()
+
+  return {
+    name: faker.name.findName(),
+    ens_name: `${ username }.eth`,
+    twitter_handle: username,
+    discord_handle: `${ username }#${ faker.random.numeric(4) }`,
+    publishedAt: randomBoolean() ? new Date().toISOString() : null
+  }
+}
+
+module.exports = {
+  generateProjectAndContributorData
+}