Ocelot-Social/backend/src/middleware/slugifyMiddleware.spec.ts

/* eslint-disable @typescript-eslint/restrict-template-expressions */
/* eslint-disable @typescript-eslint/no-unsafe-call */
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
import Factory, { cleanDatabase } from '@db/factories'
import SignupVerification from '@graphql/queries/auth/SignupVerification.gql'
import CreateGroup from '@graphql/queries/groups/CreateGroup.gql'
import UpdateGroup from '@graphql/queries/groups/UpdateGroup.gql'
import CreatePost from '@graphql/queries/posts/CreatePost.gql'
import { createApolloTestSetup } from '@root/test/helpers'

import type { ApolloTestSetup } from '@root/test/helpers'
import type { Context } from '@src/context'

let variables
const categoryIds = ['cat9']

const descriptionAdditional100 =
  ' 123456789-123456789-123456789-123456789-123456789-123456789-123456789-123456789-123456789-123456789'

let authenticatedUser: Context['user']
const context = () => ({ authenticatedUser })
let mutate: ApolloTestSetup['mutate']
let database: ApolloTestSetup['database']
let server: ApolloTestSetup['server']

beforeAll(async () => {
  await cleanDatabase()
  const testServer = await createApolloTestSetup({ context })
  mutate = testServer.mutate
  database = testServer.database
  server = testServer.server
})

afterAll(() => {
  void server.stop()
  void database.driver.close()
  database.neode.close()
})

beforeEach(async () => {
  variables = {}
  const admin = await Factory.build('user', {
    role: 'admin',
  })
  await Factory.build(
    'user',
    {},
    {
      email: 'someone@example.org',
      password: '1234',
    },
  )
  await Factory.build('category', {
    id: 'cat9',
    name: 'Democracy & Politics',
    slug: 'democracy-politics',
    icon: 'university',
  })
  authenticatedUser = await admin.toJson()
})

// TODO: avoid database clean after each test in the future if possible for performance and flakyness reasons by filling the database step by step, see issue https://github.com/Ocelot-Social-Community/Ocelot-Social/issues/4543
afterEach(async () => {
  await cleanDatabase()
})

describe('slugifyMiddleware', () => {
  describe('CreateGroup', () => {
    beforeEach(() => {
      variables = {
        ...variables,
        name: 'The Best Group',
        about: 'Some about',
        description: 'Some description' + descriptionAdditional100,
        groupType: 'closed',
        actionRadius: 'national',
        categoryIds,
      }
    })

    describe('if slug not exists', () => {
      it('generates a slug based on name', async () => {
        await expect(
          mutate({
            mutation: CreateGroup,
            variables,
          }),
        ).resolves.toMatchObject({
          data: {
            CreateGroup: {
              name: 'The Best Group',
              slug: 'the-best-group',
              about: 'Some about',
              description: 'Some description' + descriptionAdditional100,
              groupType: 'closed',
              actionRadius: 'national',
            },
          },
          errors: undefined,
        })
      })

      it('generates a slug based on given slug', async () => {
        await expect(
          mutate({
            mutation: CreateGroup,
            variables: {
              ...variables,
              slug: 'the-group',
            },
          }),
        ).resolves.toMatchObject({
          data: {
            CreateGroup: {
              slug: 'the-group',
            },
          },
          errors: undefined,
        })
      })
    })

    describe('if slug exists', () => {
      beforeEach(async () => {
        await mutate({
          mutation: CreateGroup,
          variables: {
            ...variables,
            name: 'Pre-Existing Group',
            slug: 'pre-existing-group',
            about: 'As an about',
          },
        })
      })

      it('chooses another slug', async () => {
        await expect(
          mutate({
            mutation: CreateGroup,
            variables: {
              ...variables,
              name: 'Pre-Existing Group',
              about: 'As an about',
            },
          }),
        ).resolves.toMatchObject({
          data: {
            CreateGroup: {
              slug: 'pre-existing-group-1',
            },
          },
          errors: undefined,
        })
      })

      describe('but if the client specifies a slug', () => {
        it('rejects CreateGroup', async () => {
          try {
            await expect(
              mutate({
                mutation: CreateGroup,
                variables: {
                  ...variables,
                  name: 'Pre-Existing Group',
                  about: 'As an about',
                  slug: 'pre-existing-group',
                },
              }),
            ).resolves.toMatchObject({
              errors: [
                {
                  message: 'Group with this slug already exists!',
                },
              ],
            })
          } catch (error) {
            throw new Error(`
              ${error}

              Probably your database has no unique constraints!

              To see all constraints go to http://localhost:7474/browser/ and
              paste the following:
              \`\`\`
                CALL db.constraints();
              \`\`\`

              Learn how to setup the database here:
              https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/backend/README.md#database-indices-and-constraints
            `)
          }
        })
      })
    })
  })

  describe('UpdateGroup', () => {
    let createGroupResult

    beforeEach(async () => {
      createGroupResult = await mutate({
        mutation: CreateGroup,
        variables: {
          name: 'The Best Group',
          slug: 'the-best-group',
          about: 'Some about',
          description: 'Some description' + descriptionAdditional100,
          groupType: 'closed',
          actionRadius: 'national',
          categoryIds,
        },
      })
    })

    describe('if group exists', () => {
      describe('if new slug not(!) exists', () => {
        describe('setting slug explicitly', () => {
          it('has the new slug', async () => {
            await expect(
              mutate({
                mutation: UpdateGroup,
                variables: {
                  id: createGroupResult.data.CreateGroup.id,
                  slug: 'my-best-group',
                },
              }),
            ).resolves.toMatchObject({
              data: {
                UpdateGroup: {
                  name: 'The Best Group',
                  slug: 'my-best-group',
                  about: 'Some about',
                  description: 'Some description' + descriptionAdditional100,
                  groupType: 'closed',
                  actionRadius: 'national',
                  myRole: 'owner',
                },
              },
              errors: undefined,
            })
          })
        })
      })

      describe('if new slug exists in another group', () => {
        beforeEach(async () => {
          await mutate({
            mutation: CreateGroup,
            variables: {
              name: 'Pre-Existing Group',
              slug: 'pre-existing-group',
              about: 'Some about',
              description: 'Some description' + descriptionAdditional100,
              groupType: 'closed',
              actionRadius: 'national',
              categoryIds,
            },
          })
        })

        describe('setting slug explicitly', () => {
          it('rejects UpdateGroup', async () => {
            try {
              await expect(
                mutate({
                  mutation: UpdateGroup,
                  variables: {
                    id: createGroupResult.data.CreateGroup.id,
                    slug: 'pre-existing-group',
                  },
                }),
              ).resolves.toMatchObject({
                errors: [
                  {
                    message: 'Group with this slug already exists!',
                  },
                ],
              })
            } catch (error) {
              throw new Error(`
                ${error}

                Probably your database has no unique constraints!

                To see all constraints go to http://localhost:7474/browser/ and
                paste the following:
                \`\`\`
                  CALL db.constraints();
                \`\`\`

                Learn how to setup the database here:
                https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/backend/README.md#database-indices-and-constraints
              `)
            }
          })
        })
      })
    })
  })

  describe('CreatePost', () => {
    beforeEach(() => {
      variables = {
        ...variables,
        title: 'I am a brand new post',
        content: 'Some content',
        categoryIds,
      }
    })

    describe('if slug not exists', () => {
      it('generates a slug based on title', async () => {
        await expect(
          mutate({
            mutation: CreatePost,
            variables,
          }),
        ).resolves.toMatchObject({
          data: {
            CreatePost: {
              slug: 'i-am-a-brand-new-post',
            },
          },
          errors: undefined,
        })
      })

      it('generates a slug based on given slug', async () => {
        await expect(
          mutate({
            mutation: CreatePost,
            variables: {
              ...variables,
              slug: 'the-post',
            },
          }),
        ).resolves.toMatchObject({
          data: {
            CreatePost: {
              slug: 'the-post',
            },
          },
          errors: undefined,
        })
      })
    })

    describe('if slug exists', () => {
      beforeEach(async () => {
        await Factory.build(
          'post',
          {
            title: 'Pre-existing post',
            slug: 'pre-existing-post',
            content: 'as Someone else content',
          },
          {
            categoryIds,
          },
        )
      })

      it('chooses another slug', async () => {
        await expect(
          mutate({
            mutation: CreatePost,
            variables: {
              ...variables,
              title: 'Pre-existing post',
              content: 'Some content',
              categoryIds,
            },
          }),
        ).resolves.toMatchObject({
          data: {
            CreatePost: {
              slug: 'pre-existing-post-1',
            },
          },
          errors: undefined,
        })
      })

      describe('but if the client specifies a slug', () => {
        it('rejects CreatePost', async () => {
          try {
            await expect(
              mutate({
                mutation: CreatePost,
                variables: {
                  ...variables,
                  title: 'Pre-existing post',
                  content: 'Some content',
                  slug: 'pre-existing-post',
                  categoryIds,
                },
              }),
            ).resolves.toMatchObject({
              errors: [
                {
                  message: 'Post with this slug already exists!',
                },
              ],
            })
          } catch (error) {
            throw new Error(`
              ${error}

              Probably your database has no unique constraints!

              To see all constraints go to http://localhost:7474/browser/ and
              paste the following:
              \`\`\`
                CALL db.constraints();
              \`\`\`

              Learn how to setup the database here:
              https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/backend/README.md#database-indices-and-constraints
            `)
          }
        })
      })
    })
  })

  it.todo('UpdatePost')

  describe('SignupVerification', () => {
    beforeEach(() => {
      variables = {
        ...variables,
        name: 'I am a user',
        nonce: '12345',
        password: 'yo',
        email: '123@example.org',
        termsAndConditionsAgreedVersion: '0.0.1',
      }
    })

    describe('given a user has signed up with their email address', () => {
      beforeEach(async () => {
        await Factory.build('emailAddress', {
          email: '123@example.org',
          nonce: '12345',
          verifiedAt: null,
        })
      })

      describe('if slug not exists', () => {
        it('generates a slug based on name', async () => {
          await expect(
            mutate({
              mutation: SignupVerification,
              variables,
            }),
          ).resolves.toMatchObject({
            data: {
              SignupVerification: {
                slug: 'i-am-a-user',
              },
            },
            errors: undefined,
          })
        })

        it('generates a slug based on given slug', async () => {
          await expect(
            mutate({
              mutation: SignupVerification,
              variables: {
                ...variables,
                slug: 'the-user',
              },
            }),
          ).resolves.toMatchObject({
            data: {
              SignupVerification: {
                slug: 'the-user',
              },
            },
            errors: undefined,
          })
        })
      })

      describe('if slug exists', () => {
        beforeEach(async () => {
          await Factory.build('user', {
            name: 'I am a user',
            slug: 'i-am-a-user',
          })
        })

        it('chooses another slug', async () => {
          await expect(
            mutate({
              mutation: SignupVerification,
              variables,
            }),
          ).resolves.toMatchObject({
            data: {
              SignupVerification: {
                slug: 'i-am-a-user-1',
              },
            },
            errors: undefined,
          })
        })

        describe('but if the client specifies a slug', () => {
          beforeEach(() => {
            variables = {
              ...variables,
              slug: 'i-am-a-user',
            }
          })

          it('rejects SignupVerification (on FAIL Neo4j constraints may not defined in database)', async () => {
            await expect(
              mutate({
                mutation: SignupVerification,
                variables,
              }),
            ).resolves.toMatchObject({
              errors: [
                {
                  message: 'User with this slug already exists!',
                },
              ],
            })
          })
        })
      })
    })
  })
})