Merge pull request #2136 from gradido/update-contributions-table

feat: Migrate Contributions Table

backend/src/config/index.ts

@@ -10,7 +10,7 @@ Decimal.set({
 })
 
 const constants = {
-  DB_VERSION: '0044-insert_missing_contributions',
+  DB_VERSION: '0045-add_denied_type_and_status_to_contributions',
   DECAY_START_TIME: new Date('2021-05-13 17:46:31-0000'), // GMT+0
   LOG4JS_CONFIG: 'log4js-config.json',
   // default log level on production should be info

backend/src/graphql/enum/ContributionStatus.ts

@@ -0,0 +1,14 @@
+import { registerEnumType } from 'type-graphql'
+
+export enum ContributionStatus {
+  PENDING = 'PENDING',
+  DELETED = 'DELETED',
+  IN_PROGRESS = 'IN_PROGRESS',
+  DENIED = 'DENIED',
+  CONFIRMED = 'CONFIRMED',
+}
+
+registerEnumType(ContributionStatus, {
+  name: 'ContributionStatus',
+  description: 'Name of the Type of the Contribution Status',
+})

backend/src/graphql/enum/ContributionType.ts

@@ -0,0 +1,12 @@
+import { registerEnumType } from 'type-graphql'
+
+export enum ContributionType {
+  ADMIN = 'ADMIN',
+  USER = 'USER',
+  LINK = 'LINK',
+}
+
+registerEnumType(ContributionType, {
+  name: 'ContributionType',
+  description: 'Name of the Type of the Contribution',
+})

backend/src/graphql/resolver/AdminResolver.ts

@@ -36,6 +36,8 @@ import { LoginEmailOptIn } from '@entity/LoginEmailOptIn'
 import { User as dbUser } from '@entity/User'
 import { User } from '@model/User'
 import { TransactionTypeId } from '@enum/TransactionTypeId'
+import { ContributionType } from '@enum/ContributionType'
+import { ContributionStatus } from '@enum/ContributionStatus'
 import Decimal from 'decimal.js-light'
 import { Decay } from '@model/Decay'
 import Paginated from '@arg/Paginated'
@@ -260,6 +262,8 @@ export class AdminResolver {
     contribution.contributionDate = creationDateObj
     contribution.memo = memo
     contribution.moderatorId = moderator.id
+    contribution.contributionType = ContributionType.ADMIN
+    contribution.contributionStatus = ContributionStatus.PENDING
 
     logger.trace('contribution to save', contribution)
     await Contribution.save(contribution)
@@ -337,6 +341,7 @@ export class AdminResolver {
     contributionToUpdate.memo = memo
     contributionToUpdate.contributionDate = new Date(creationDate)
     contributionToUpdate.moderatorId = moderator.id
+    contributionToUpdate.contributionStatus = ContributionStatus.PENDING
 
     await Contribution.save(contributionToUpdate)
     const result = new AdminUpdateContribution()
@@ -387,6 +392,8 @@ export class AdminResolver {
     if (!contribution) {
       throw new Error('Contribution not found for given id.')
     }
+    contribution.contributionStatus = ContributionStatus.DELETED
+    await contribution.save()
     const res = await contribution.softRemove()
     return !!res
   }
@@ -454,6 +461,7 @@ export class AdminResolver {
       contribution.confirmedAt = receivedCallDate
       contribution.confirmedBy = moderatorUser.id
       contribution.transactionId = transaction.id
+      contribution.contributionStatus = ContributionStatus.CONFIRMED
       await queryRunner.manager.update(Contribution, { id: contribution.id }, contribution)
 
       await queryRunner.commitTransaction()

backend/src/graphql/resolver/ContributionResolver.ts

@@ -7,6 +7,8 @@ import { FindOperator, IsNull, getConnection } from '@dbTools/typeorm'
 import ContributionArgs from '@arg/ContributionArgs'
 import Paginated from '@arg/Paginated'
 import { Order } from '@enum/Order'
+import { ContributionType } from '@enum/ContributionType'
+import { ContributionStatus } from '@enum/ContributionStatus'
 import { Contribution, ContributionListResult } from '@model/Contribution'
 import { UnconfirmedContribution } from '@model/UnconfirmedContribution'
 import { User } from '@model/User'
@@ -43,6 +45,8 @@ export class ContributionResolver {
     contribution.createdAt = new Date()
     contribution.contributionDate = creationDateObj
     contribution.memo = memo
+    contribution.contributionType = ContributionType.USER
+    contribution.contributionStatus = ContributionStatus.PENDING
 
     logger.trace('contribution to save', contribution)
     await dbContribution.save(contribution)
@@ -66,6 +70,8 @@ export class ContributionResolver {
     if (contribution.confirmedAt) {
       throw new Error('A confirmed contribution can not be deleted')
     }
+    contribution.contributionStatus = ContributionStatus.DELETED
+    await contribution.save()
     const res = await contribution.softRemove()
     return !!res
   }
@@ -164,6 +170,7 @@ export class ContributionResolver {
     contributionToUpdate.amount = amount
     contributionToUpdate.memo = memo
     contributionToUpdate.contributionDate = new Date(creationDate)
+    contributionToUpdate.contributionStatus = ContributionStatus.PENDING
     dbContribution.save(contributionToUpdate)
 
     return new UnconfirmedContribution(contributionToUpdate, user, creations)

backend/src/graphql/resolver/TransactionLinkResolver.ts

@@ -26,6 +26,8 @@ import { User } from '@model/User'
 import { calculateDecay } from '@/util/decay'
 import { executeTransaction } from './TransactionResolver'
 import { Order } from '@enum/Order'
+import { ContributionType } from '@enum/ContributionType'
+import { ContributionStatus } from '@enum/ContributionStatus'
 import { Contribution as DbContribution } from '@entity/Contribution'
 import { ContributionLink as DbContributionLink } from '@entity/ContributionLink'
 import { getUserCreation, validateContribution } from './util/creations'
@@ -231,6 +233,9 @@ export class TransactionLinkResolver {
         contribution.memo = contributionLink.memo
         contribution.amount = contributionLink.amount
         contribution.contributionLinkId = contributionLink.id
+        contribution.contributionType = ContributionType.LINK
+        contribution.contributionStatus = ContributionStatus.CONFIRMED
+
         await queryRunner.manager.insert(DbContribution, contribution)
 
         const lastTransaction = await queryRunner.manager

database/entity/0045-add_denied_type_and_status_to_contributions/Contribution.ts

@@ -0,0 +1,83 @@
+import Decimal from 'decimal.js-light'
+import {
+  BaseEntity,
+  Column,
+  Entity,
+  PrimaryGeneratedColumn,
+  DeleteDateColumn,
+  JoinColumn,
+  ManyToOne,
+} from 'typeorm'
+import { DecimalTransformer } from '../../src/typeorm/DecimalTransformer'
+import { User } from '../User'
+
+@Entity('contributions')
+export class Contribution extends BaseEntity {
+  @PrimaryGeneratedColumn('increment', { unsigned: true })
+  id: number
+
+  @Column({ unsigned: true, nullable: false, name: 'user_id' })
+  userId: number
+
+  @ManyToOne(() => User, (user) => user.contributions)
+  @JoinColumn({ name: 'user_id' })
+  user: User
+
+  @Column({ type: 'datetime', default: () => 'CURRENT_TIMESTAMP', name: 'created_at' })
+  createdAt: Date
+
+  @Column({ type: 'datetime', nullable: false, name: 'contribution_date' })
+  contributionDate: Date
+
+  @Column({ length: 255, nullable: false, collation: 'utf8mb4_unicode_ci' })
+  memo: string
+
+  @Column({
+    type: 'decimal',
+    precision: 40,
+    scale: 20,
+    nullable: false,
+    transformer: DecimalTransformer,
+  })
+  amount: Decimal
+
+  @Column({ unsigned: true, nullable: true, name: 'moderator_id' })
+  moderatorId: number
+
+  @Column({ unsigned: true, nullable: true, name: 'contribution_link_id' })
+  contributionLinkId: number
+
+  @Column({ unsigned: true, nullable: true, name: 'confirmed_by' })
+  confirmedBy: number
+
+  @Column({ nullable: true, name: 'confirmed_at' })
+  confirmedAt: Date
+
+  @Column({ unsigned: true, nullable: true, name: 'denied_by' })
+  deniedBy: number
+
+  @Column({ nullable: true, name: 'denied_at' })
+  deniedAt: Date
+
+  @Column({
+    name: 'contribution_type',
+    length: 12,
+    nullable: false,
+    collation: 'utf8mb4_unicode_ci',
+  })
+  contributionType: string
+
+  @Column({
+    name: 'contribution_status',
+    length: 12,
+    nullable: false,
+    collation: 'utf8mb4_unicode_ci',
+  })
+  contributionStatus: string
+
+  @Column({ unsigned: true, nullable: true, name: 'transaction_id' })
+  transactionId: number
+
+  @DeleteDateColumn({ name: 'deleted_at' })
+  deletedAt: Date | null
+}

database/entity/Contribution.ts

@@ -1 +1 @@
-export { Contribution } from './0039-contributions_table/Contribution'
+export { Contribution } from './0045-add_denied_type_and_status_to_contributions/Contribution'

database/migrations/0045-add_denied_type_and_status_to_contributions.ts

@@ -0,0 +1,39 @@
+/* MIGRATION TO ADD denied_by, denied_at, contribution_type and contrinution_status 
+FIELDS TO contributions */
+
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+export async function upgrade(queryFn: (query: string, values?: any[]) => Promise<Array<any>>) {
+  await queryFn(
+    'ALTER TABLE `contributions` ADD COLUMN `denied_at` datetime DEFAULT NULL AFTER `confirmed_at`;',
+  )
+  await queryFn(
+    'ALTER TABLE `contributions` ADD COLUMN `denied_by` int(10) unsigned DEFAULT NULL AFTER `denied_at`;',
+  )
+  await queryFn(
+    'ALTER TABLE `contributions` ADD COLUMN `contribution_type` varchar(12) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT "ADMIN"  AFTER `denied_by`;',
+  )
+  await queryFn(
+    'ALTER TABLE `contributions` ADD COLUMN `contribution_status` varchar(12) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT "PENDING" AFTER `contribution_type`;',
+  )
+  await queryFn(
+    'UPDATE `contributions` SET `contribution_type` = "LINK" WHERE `contribution_link_id` IS NOT NULL;',
+  )
+  await queryFn(
+    'UPDATE `contributions` SET `contribution_type` = "USER" WHERE `contribution_link_id` IS NULL AND `moderator_id` IS NULL;',
+  )
+  await queryFn(
+    'UPDATE `contributions` SET `contribution_status` = "CONFIRMED" WHERE `confirmed_at` IS NOT NULL;',
+  )
+  await queryFn(
+    'UPDATE `contributions` SET `contribution_status` = "DELETED" WHERE `deleted_at` IS NOT NULL;',
+  )
+}
+
+export async function downgrade(queryFn: (query: string, values?: any[]) => Promise<Array<any>>) {
+  await queryFn('ALTER TABLE `contributions` DROP COLUMN `contribution_status`;')
+  await queryFn('ALTER TABLE `contributions` DROP COLUMN `contribution_type`;')
+  await queryFn('ALTER TABLE `contributions` DROP COLUMN `denied_by`;')
+  await queryFn('ALTER TABLE `contributions` DROP COLUMN `denied_at`;')
+}