feat: 🍰 Implement Group GQL Model And CRUD Resolvers – First Step

backend/.env.template

@@ -29,4 +29,4 @@ AWS_BUCKET=
 EMAIL_DEFAULT_SENDER="devops@ocelot.social"
 EMAIL_SUPPORT="devops@ocelot.social"
 
-CATEGORIES_ACTIVE=false
+CATEGORIES_ACTIVE=false

backend/package.json

@@ -103,7 +103,7 @@
     "mustache": "^4.2.0",
     "neo4j-driver": "^4.0.2",
     "neo4j-graphql-js": "^2.11.5",
-    "neode": "^0.4.7",
+    "neode": "^0.4.8",
     "node-fetch": "~2.6.1",
     "nodemailer": "^6.4.4",
     "nodemailer-html-to-text": "^3.2.0",

backend/src/constants/categories.js

@@ -0,0 +1,3 @@
+// this file is duplicated in `backend/src/constants/metadata.js` and `webapp/constants/metadata.js`
+export const CATEGORIES_MIN = 1
+export const CATEGORIES_MAX = 3

backend/src/constants/groups.js

@@ -0,0 +1,2 @@
+// this file is duplicated in `backend/src/constants/group.js` and `webapp/constants/group.js`
+export const DESCRIPTION_WITHOUT_HTML_LENGTH_MIN = 100 // with removed HTML tags

backend/src/db/graphql/authentications.js

@@ -0,0 +1,29 @@
+import gql from 'graphql-tag'
+
+// ------ mutations
+
+export const signupVerificationMutation = gql`
+  mutation (
+    $password: String!
+    $email: String!
+    $name: String!
+    $slug: String
+    $nonce: String!
+    $termsAndConditionsAgreedVersion: String!
+  ) {
+    SignupVerification(
+      email: $email
+      password: $password
+      name: $name
+      slug: $slug
+      nonce: $nonce
+      termsAndConditionsAgreedVersion: $termsAndConditionsAgreedVersion
+    ) {
+      slug
+    }
+  }
+`
+
+// ------ queries
+
+// fill queries in here

backend/src/db/graphql/groups.js

@@ -0,0 +1,95 @@
+import gql from 'graphql-tag'
+
+// ------ mutations
+
+export const createGroupMutation = gql`
+  mutation (
+    $id: ID
+    $name: String!
+    $slug: String
+    $about: String
+    $description: String!
+    $groupType: GroupType!
+    $actionRadius: GroupActionRadius!
+    $categoryIds: [ID]
+  ) {
+    CreateGroup(
+      id: $id
+      name: $name
+      slug: $slug
+      about: $about
+      description: $description
+      groupType: $groupType
+      actionRadius: $actionRadius
+      categoryIds: $categoryIds
+    ) {
+      id
+      name
+      slug
+      createdAt
+      updatedAt
+      disabled
+      deleted
+      about
+      description
+      groupType
+      actionRadius
+      myRole
+    }
+  }
+`
+
+// ------ queries
+
+export const groupQuery = gql`
+  query (
+    $isMember: Boolean
+    $id: ID
+    $name: String
+    $slug: String
+    $createdAt: String
+    $updatedAt: String
+    $about: String
+    $description: String
+    $locationName: String
+    $first: Int
+    $offset: Int
+    $orderBy: [_GroupOrdering]
+    $filter: _GroupFilter
+  ) {
+    Group(
+      isMember: $isMember
+      id: $id
+      name: $name
+      slug: $slug
+      createdAt: $createdAt
+      updatedAt: $updatedAt
+      about: $about
+      description: $description
+      locationName: $locationName
+      first: $first
+      offset: $offset
+      orderBy: $orderBy
+      filter: $filter
+    ) {
+      id
+      name
+      slug
+      createdAt
+      updatedAt
+      disabled
+      deleted
+      about
+      description
+      groupType
+      actionRadius
+      myRole
+      categories {
+        id
+        slug
+        name
+        icon
+      }
+    }
+  }
+`

backend/src/db/graphql/posts.js

@@ -0,0 +1,15 @@
+import gql from 'graphql-tag'
+
+// ------ mutations
+
+export const createPostMutation = gql`
+  mutation ($title: String!, $content: String!, $categoryIds: [ID]!, $slug: String) {
+    CreatePost(title: $title, content: $content, categoryIds: $categoryIds, slug: $slug) {
+      slug
+    }
+  }
+`
+
+// ------ queries
+
+// fill queries in here

backend/src/db/migrate/store.js

@@ -59,11 +59,11 @@ class Store {
     const session = driver.session()
     await createDefaultAdminUser(session)
     const writeTxResultPromise = session.writeTransaction(async (txc) => {
-      await txc.run('CALL apoc.schema.assert({},{},true)') // drop all indices
+      await txc.run('CALL apoc.schema.assert({},{},true)') // drop all indices and contraints
       return Promise.all(
         [
-          'CALL db.index.fulltext.createNodeIndex("post_fulltext_search",["Post"],["title", "content"])',
           'CALL db.index.fulltext.createNodeIndex("user_fulltext_search",["User"],["name", "slug"])',
+          'CALL db.index.fulltext.createNodeIndex("post_fulltext_search",["Post"],["title", "content"])',
           'CALL db.index.fulltext.createNodeIndex("tag_fulltext_search",["Tag"],["id"])',
         ].map((statement) => txc.run(statement)),
       )

backend/src/db/migrations/20220803060819-create_fulltext_indices_and_unique_keys_for_groups.js

@@ -0,0 +1,66 @@
+import { getDriver } from '../../db/neo4j'
+
+export const description = `
+  We introduced a new node label 'Group' and we need two primary keys 'id' and 'slug' for it.
+  Additional we like to have fulltext indices the keys 'name', 'slug', 'about', and 'description'.
+`
+
+export async function up(next) {
+  const driver = getDriver()
+  const session = driver.session()
+  const transaction = session.beginTransaction()
+
+  try {
+    // Implement your migration here.
+    await transaction.run(`
+      CREATE CONSTRAINT ON ( group:Group ) ASSERT group.id IS UNIQUE
+    `)
+    await transaction.run(`
+      CREATE CONSTRAINT ON ( group:Group ) ASSERT group.slug IS UNIQUE
+    `)
+    await transaction.run(`
+      CALL db.index.fulltext.createNodeIndex("group_fulltext_search",["Group"],["name", "slug", "about", "description"])
+    `)
+    await transaction.commit()
+    next()
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.log(error)
+    await transaction.rollback()
+    // eslint-disable-next-line no-console
+    console.log('rolled back')
+    throw new Error(error)
+  } finally {
+    session.close()
+  }
+}
+
+export async function down(next) {
+  const driver = getDriver()
+  const session = driver.session()
+  const transaction = session.beginTransaction()
+
+  try {
+    // Implement your migration here.
+    await transaction.run(`
+      DROP CONSTRAINT ON ( group:Group ) ASSERT group.id IS UNIQUE
+    `)
+    await transaction.run(`
+      DROP CONSTRAINT ON ( group:Group ) ASSERT group.slug IS UNIQUE
+    `)
+    await transaction.run(`
+      CALL db.index.fulltext.drop("group_fulltext_search")
+    `)
+    await transaction.commit()
+    next()
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.log(error)
+    await transaction.rollback()
+    // eslint-disable-next-line no-console
+    console.log('rolled back')
+    throw new Error(error)
+  } finally {
+    session.close()
+  }
+}

backend/src/helpers/jest.js

@@ -1,3 +1,7 @@
+// TODO: can be replaced with: (which is no a fake)
+// import gql from 'graphql-tag'
+// See issue: https://github.com/Ocelot-Social-Community/Ocelot-Social/issues/5152
+
 //* This is a fake ES2015 template string, just to benefit of syntax
 // highlighting of `gql` template strings in certain editors.
 export function gql(strings) {

backend/src/middleware/excerptMiddleware.js

@@ -2,6 +2,11 @@ import trunc from 'trunc-html'
 
 export default {
   Mutation: {
+    CreateGroup: async (resolve, root, args, context, info) => {
+      args.descriptionExcerpt = trunc(args.description, 120).html
+      const result = await resolve(root, args, context, info)
+      return result
+    },
     CreatePost: async (resolve, root, args, context, info) => {
       args.contentExcerpt = trunc(args.content, 120).html
       const result = await resolve(root, args, context, info)

backend/src/middleware/helpers/cleanHtml.js

@@ -1,6 +1,13 @@
 import sanitizeHtml from 'sanitize-html'
 import linkifyHtml from 'linkifyjs/html'
 
+export const removeHtmlTags = (input) => {
+  return sanitizeHtml(input, {
+    allowedTags: [],
+    allowedAttributes: {},
+  })
+}
+
 const standardSanitizeHtmlOptions = {
   allowedTags: [
     'img',

backend/src/middleware/languages/languages.js

@@ -1,12 +1,5 @@
 import LanguageDetect from 'languagedetect'
-import sanitizeHtml from 'sanitize-html'
-
-const removeHtmlTags = (input) => {
-  return sanitizeHtml(input, {
-    allowedTags: [],
-    allowedAttributes: {},
-  })
-}
+import { removeHtmlTags } from '../helpers/cleanHtml.js'
 
 const setPostLanguage = (text) => {
   const lngDetector = new LanguageDetect()

backend/src/middleware/permissionsMiddleware.js

@@ -114,6 +114,7 @@ export default shield(
       reports: isModerator,
       statistics: allow,
       currentUser: allow,
+      Group: isAuthenticated,
       Post: allow,
       profilePagePosts: allow,
       Comment: allow,
@@ -140,6 +141,7 @@ export default shield(
       Signup: or(publicRegistration, inviteRegistration, isAdmin),
       SignupVerification: allow,
       UpdateUser: onlyYourself,
+      CreateGroup: isAuthenticated,
       CreatePost: isAuthenticated,
       UpdatePost: isAuthor,
       DeletePost: isAuthor,

backend/src/middleware/sluggifyMiddleware.js

@@ -26,6 +26,10 @@ export default {
       args.slug = args.slug || (await uniqueSlug(args.name, isUniqueFor(context, 'User')))
       return resolve(root, args, context, info)
     },
+    CreateGroup: async (resolve, root, args, context, info) => {
+      args.slug = args.slug || (await uniqueSlug(args.name, isUniqueFor(context, 'Group')))
+      return resolve(root, args, context, info)
+    },
     CreatePost: async (resolve, root, args, context, info) => {
       args.slug = args.slug || (await uniqueSlug(args.title, isUniqueFor(context, 'Post')))
       return resolve(root, args, context, info)

backend/src/middleware/slugify/uniqueSlug.js

@@ -1,4 +1,5 @@
 import slugify from 'slug'
+
 export default async function uniqueSlug(string, isUnique) {
   const slug = slugify(string || 'anonymous', {
     lower: true,