Merge branch 'master' into 2876-add-fields-to-subscriber

backend/src/config/index.ts

@@ -12,7 +12,7 @@ Decimal.set({
 })
 
 const constants = {
-  DB_VERSION: '0064-event_rename',
+  DB_VERSION: '0065-refactor_communities_table',
   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/federation/client/1_0/FederationClient.ts

@@ -1,14 +1,16 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 import { gql } from 'graphql-request'
 
 import { GraphQLGetClient } from '@/federation/client/GraphQLGetClient'
 import { LogError } from '@/server/LogError'
 import { backendLogger as logger } from '@/server/logger'
 
-export async function requestGetPublicKey(dbCom: DbCommunity): Promise<string | undefined> {
+export async function requestGetPublicKey(
+  dbCom: DbFederatedCommunity,
+): Promise<string | undefined> {
   let endpoint = dbCom.endPoint.endsWith('/') ? dbCom.endPoint : dbCom.endPoint + '/'
   endpoint = `${endpoint}${dbCom.apiVersion}/`
   logger.info(`requestGetPublicKey with endpoint='${endpoint}'...`)

backend/src/federation/client/1_1/FederationClient.ts

@@ -1,14 +1,16 @@
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 import { gql } from 'graphql-request'
 
 import { GraphQLGetClient } from '@/federation/client/GraphQLGetClient'
 import { LogError } from '@/server/LogError'
 import { backendLogger as logger } from '@/server/logger'
 
-export async function requestGetPublicKey(dbCom: DbCommunity): Promise<string | undefined> {
+export async function requestGetPublicKey(
+  dbCom: DbFederatedCommunity,
+): Promise<string | undefined> {
   let endpoint = dbCom.endPoint.endsWith('/') ? dbCom.endPoint : dbCom.endPoint + '/'
   endpoint = `${endpoint}${dbCom.apiVersion}/`
   logger.info(`requestGetPublicKey with endpoint='${endpoint}'...`)

backend/src/federation/validateCommunities.test.ts

@@ -1,5 +1,12 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/unbound-method */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+
 import { Connection } from '@dbTools/typeorm'
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 import { ApolloServerTestClient } from 'apollo-server-testing'
 
 import { testEnvironment, cleanDB } from '@test/helpers'
@@ -58,9 +65,9 @@ describe('validate Communities', () => {
           endPoint: 'http//localhost:5001/api/',
           lastAnnouncedAt: new Date(),
         }
-        await DbCommunity.createQueryBuilder()
+        await DbFederatedCommunity.createQueryBuilder()
           .insert()
-          .into(DbCommunity)
+          .into(DbFederatedCommunity)
           .values(variables1)
           .orUpdate({
             conflict_target: ['id', 'publicKey', 'apiVersion'],
@@ -89,9 +96,9 @@ describe('validate Communities', () => {
           endPoint: 'http//localhost:5001/api/',
           lastAnnouncedAt: new Date(),
         }
-        await DbCommunity.createQueryBuilder()
+        await DbFederatedCommunity.createQueryBuilder()
           .insert()
-          .into(DbCommunity)
+          .into(DbFederatedCommunity)
           .values(variables2)
           .orUpdate({
             conflict_target: ['id', 'publicKey', 'apiVersion'],
@@ -117,7 +124,7 @@ describe('validate Communities', () => {
       })
     })
     describe('with three Communities of api 1_0, 1_1 and 2_0', () => {
-      let dbCom: DbCommunity
+      let dbCom: DbFederatedCommunity
       beforeEach(async () => {
         const variables3 = {
           publicKey: Buffer.from('11111111111111111111111111111111'),
@@ -125,16 +132,16 @@ describe('validate Communities', () => {
           endPoint: 'http//localhost:5001/api/',
           lastAnnouncedAt: new Date(),
         }
-        await DbCommunity.createQueryBuilder()
+        await DbFederatedCommunity.createQueryBuilder()
           .insert()
-          .into(DbCommunity)
+          .into(DbFederatedCommunity)
           .values(variables3)
           .orUpdate({
             conflict_target: ['id', 'publicKey', 'apiVersion'],
             overwrite: ['end_point', 'last_announced_at'],
           })
           .execute()
-        dbCom = await DbCommunity.findOneOrFail({
+        dbCom = await DbFederatedCommunity.findOneOrFail({
           where: { publicKey: variables3.publicKey, apiVersion: variables3.apiVersion },
         })
         jest.clearAllMocks()

backend/src/federation/validateCommunities.ts

@@ -1,5 +1,7 @@
+/** eslint-disable @typescript-eslint/no-unsafe-call */
+/** eslint-disable @typescript-eslint/no-unsafe-assignment */
 import { IsNull } from '@dbTools/typeorm'
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 
 import { LogError } from '@/server/LogError'
 import { backendLogger as logger } from '@/server/logger'
@@ -23,13 +25,14 @@ export function startValidateCommunities(timerInterval: number): void {
 }
 
 export async function validateCommunities(): Promise<void> {
-  const dbCommunities: DbCommunity[] = await DbCommunity.createQueryBuilder()
+  const dbFederatedCommunities: DbFederatedCommunity[] =
-    .where({ foreign: true, verifiedAt: IsNull() })
+    await DbFederatedCommunity.createQueryBuilder()
-    .orWhere('verified_at < last_announced_at')
+      .where({ foreign: true, verifiedAt: IsNull() })
-    .getMany()
+      .orWhere('verified_at < last_announced_at')
+      .getMany()
 
-  logger.debug(`Federation: found ${dbCommunities.length} dbCommunities`)
+  logger.debug(`Federation: found ${dbFederatedCommunities.length} dbCommunities`)
-  for (const dbCom of dbCommunities) {
+  for (const dbCom of dbFederatedCommunities) {
     logger.debug('Federation: dbCom', dbCom)
     const apiValueStrings: string[] = Object.values(ApiVersionType)
     logger.debug(`suppported ApiVersions=`, apiValueStrings)
@@ -46,7 +49,7 @@ export async function validateCommunities(): Promise<void> {
         )
         if (pubKey && pubKey === dbCom.publicKey.toString()) {
           logger.info(`Federation: matching publicKey:  ${pubKey}`)
-          await DbCommunity.update({ id: dbCom.id }, { verifiedAt: new Date() })
+          await DbFederatedCommunity.update({ id: dbCom.id }, { verifiedAt: new Date() })
           logger.debug(`Federation: updated dbCom:  ${JSON.stringify(dbCom)}`)
         } else {
           logger.warn(
@@ -74,7 +77,9 @@ function isLogError(err: unknown) {
   return err instanceof LogError
 }
 
-async function invokeVersionedRequestGetPublicKey(dbCom: DbCommunity): Promise<string | undefined> {
+async function invokeVersionedRequestGetPublicKey(
+  dbCom: DbFederatedCommunity,
+): Promise<string | undefined> {
   switch (dbCom.apiVersion) {
     case ApiVersionType.V1_0:
       return v1_0_requestGetPublicKey(dbCom)

backend/src/graphql/model/Community.ts

@@ -6,14 +6,12 @@ export class Community {
   constructor(dbCom: DbCommunity) {
     this.id = dbCom.id
     this.foreign = dbCom.foreign
-    this.publicKey = dbCom.publicKey.toString()
+    this.name = dbCom.name
-    this.url =
+    this.description = dbCom.description
-      (dbCom.endPoint.endsWith('/') ? dbCom.endPoint : dbCom.endPoint + '/') + dbCom.apiVersion
+    this.url = dbCom.url
-    this.lastAnnouncedAt = dbCom.lastAnnouncedAt
+    this.creationDate = dbCom.creationDate
-    this.verifiedAt = dbCom.verifiedAt
+    this.uuid = dbCom.communityUuid
-    this.lastErrorAt = dbCom.lastErrorAt
+    this.authenticatedAt = dbCom.authenticatedAt
-    this.createdAt = dbCom.createdAt
-    this.updatedAt = dbCom.updatedAt
   }
 
   @Field(() => Int)
@@ -22,24 +20,21 @@ export class Community {
   @Field(() => Boolean)
   foreign: boolean
 
-  @Field(() => String)
+  @Field(() => String, { nullable: true })
-  publicKey: string
+  name: string | null
+
+  @Field(() => String, { nullable: true })
+  description: string | null
 
   @Field(() => String)
   url: string
 
   @Field(() => Date, { nullable: true })
-  lastAnnouncedAt: Date | null
+  creationDate: Date | null
+
+  @Field(() => String, { nullable: true })
+  uuid: string | null
 
   @Field(() => Date, { nullable: true })
-  verifiedAt: Date | null
+  authenticatedAt: Date | null
-
-  @Field(() => Date, { nullable: true })
-  lastErrorAt: Date | null
-
-  @Field(() => Date, { nullable: true })
-  createdAt: Date | null
-
-  @Field(() => Date, { nullable: true })
-  updatedAt: Date | null
 }

backend/src/graphql/model/FederatedCommunity.ts

@@ -0,0 +1,45 @@
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
+import { ObjectType, Field, Int } from 'type-graphql'
+
+@ObjectType()
+export class FederatedCommunity {
+  constructor(dbCom: DbFederatedCommunity) {
+    this.id = dbCom.id
+    this.foreign = dbCom.foreign
+    this.publicKey = dbCom.publicKey.toString()
+    this.url =
+      (dbCom.endPoint.endsWith('/') ? dbCom.endPoint : dbCom.endPoint + '/') + dbCom.apiVersion
+    this.lastAnnouncedAt = dbCom.lastAnnouncedAt
+    this.verifiedAt = dbCom.verifiedAt
+    this.lastErrorAt = dbCom.lastErrorAt
+    this.createdAt = dbCom.createdAt
+    this.updatedAt = dbCom.updatedAt
+  }
+
+  @Field(() => Int)
+  id: number
+
+  @Field(() => Boolean)
+  foreign: boolean
+
+  @Field(() => String)
+  publicKey: string
+
+  @Field(() => String)
+  url: string
+
+  @Field(() => Date, { nullable: true })
+  lastAnnouncedAt: Date | null
+
+  @Field(() => Date, { nullable: true })
+  verifiedAt: Date | null
+
+  @Field(() => Date, { nullable: true })
+  lastErrorAt: Date | null
+
+  @Field(() => Date, { nullable: true })
+  createdAt: Date | null
+
+  @Field(() => Date, { nullable: true })
+  updatedAt: Date | null
+}

backend/src/graphql/resolver/CommunityResolver.test.ts

@@ -1,6 +1,12 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/unbound-method */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+
 import { Connection } from '@dbTools/typeorm'
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 import { ApolloServerTestClient } from 'apollo-server-testing'
 
 import { testEnvironment } from '@test/helpers'
@@ -19,7 +25,7 @@ beforeAll(async () => {
   testEnv = await testEnvironment()
   query = testEnv.query
   con = testEnv.con
-  await DbCommunity.clear()
+  await DbFederatedCommunity.clear()
 })
 
 afterAll(async () => {
@@ -28,12 +34,12 @@ afterAll(async () => {
 
 describe('CommunityResolver', () => {
   describe('getCommunities', () => {
-    let homeCom1: DbCommunity
+    let homeCom1: DbFederatedCommunity
-    let homeCom2: DbCommunity
+    let homeCom2: DbFederatedCommunity
-    let homeCom3: DbCommunity
+    let homeCom3: DbFederatedCommunity
-    let foreignCom1: DbCommunity
+    let foreignCom1: DbFederatedCommunity
-    let foreignCom2: DbCommunity
+    let foreignCom2: DbFederatedCommunity
-    let foreignCom3: DbCommunity
+    let foreignCom3: DbFederatedCommunity
 
     describe('with empty list', () => {
       it('returns no community entry', async () => {
@@ -51,29 +57,29 @@ describe('CommunityResolver', () => {
       beforeEach(async () => {
         jest.clearAllMocks()
 
-        homeCom1 = DbCommunity.create()
+        homeCom1 = DbFederatedCommunity.create()
         homeCom1.foreign = false
         homeCom1.publicKey = Buffer.from('publicKey-HomeCommunity')
         homeCom1.apiVersion = '1_0'
         homeCom1.endPoint = 'http://localhost/api'
         homeCom1.createdAt = new Date()
-        await DbCommunity.insert(homeCom1)
+        await DbFederatedCommunity.insert(homeCom1)
 
-        homeCom2 = DbCommunity.create()
+        homeCom2 = DbFederatedCommunity.create()
         homeCom2.foreign = false
         homeCom2.publicKey = Buffer.from('publicKey-HomeCommunity')
         homeCom2.apiVersion = '1_1'
         homeCom2.endPoint = 'http://localhost/api'
         homeCom2.createdAt = new Date()
-        await DbCommunity.insert(homeCom2)
+        await DbFederatedCommunity.insert(homeCom2)
 
-        homeCom3 = DbCommunity.create()
+        homeCom3 = DbFederatedCommunity.create()
         homeCom3.foreign = false
         homeCom3.publicKey = Buffer.from('publicKey-HomeCommunity')
         homeCom3.apiVersion = '2_0'
         homeCom3.endPoint = 'http://localhost/api'
         homeCom3.createdAt = new Date()
-        await DbCommunity.insert(homeCom3)
+        await DbFederatedCommunity.insert(homeCom3)
       })
 
       it('returns 3 home-community entries', async () => {
@@ -123,29 +129,29 @@ describe('CommunityResolver', () => {
       beforeEach(async () => {
         jest.clearAllMocks()
 
-        foreignCom1 = DbCommunity.create()
+        foreignCom1 = DbFederatedCommunity.create()
         foreignCom1.foreign = true
         foreignCom1.publicKey = Buffer.from('publicKey-ForeignCommunity')
         foreignCom1.apiVersion = '1_0'
         foreignCom1.endPoint = 'http://remotehost/api'
         foreignCom1.createdAt = new Date()
-        await DbCommunity.insert(foreignCom1)
+        await DbFederatedCommunity.insert(foreignCom1)
 
-        foreignCom2 = DbCommunity.create()
+        foreignCom2 = DbFederatedCommunity.create()
         foreignCom2.foreign = true
         foreignCom2.publicKey = Buffer.from('publicKey-ForeignCommunity')
         foreignCom2.apiVersion = '1_1'
         foreignCom2.endPoint = 'http://remotehost/api'
         foreignCom2.createdAt = new Date()
-        await DbCommunity.insert(foreignCom2)
+        await DbFederatedCommunity.insert(foreignCom2)
 
-        foreignCom3 = DbCommunity.create()
+        foreignCom3 = DbFederatedCommunity.create()
         foreignCom3.foreign = true
         foreignCom3.publicKey = Buffer.from('publicKey-ForeignCommunity')
         foreignCom3.apiVersion = '1_2'
         foreignCom3.endPoint = 'http://remotehost/api'
         foreignCom3.createdAt = new Date()
-        await DbCommunity.insert(foreignCom3)
+        await DbFederatedCommunity.insert(foreignCom3)
       })
 
       it('returns 3 home community and 3 foreign community entries', async () => {

backend/src/graphql/resolver/CommunityResolver.ts

@@ -1,22 +1,37 @@
 import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 import { Resolver, Query, Authorized } from 'type-graphql'
 
 import { Community } from '@model/Community'
+import { FederatedCommunity } from '@model/FederatedCommunity'
 
 import { RIGHTS } from '@/auth/RIGHTS'
 
 @Resolver()
 export class CommunityResolver {
   @Authorized([RIGHTS.COMMUNITIES])
-  @Query(() => [Community])
+  @Query(() => [FederatedCommunity])
-  async getCommunities(): Promise<Community[]> {
+  async getCommunities(): Promise<FederatedCommunity[]> {
-    const dbCommunities: DbCommunity[] = await DbCommunity.find({
+    const dbFederatedCommunities: DbFederatedCommunity[] = await DbFederatedCommunity.find({
       order: {
         foreign: 'ASC',
         createdAt: 'DESC',
         lastAnnouncedAt: 'DESC',
       },
     })
+    return dbFederatedCommunities.map(
+      (dbCom: DbFederatedCommunity) => new FederatedCommunity(dbCom),
+    )
+  }
+
+  @Authorized([RIGHTS.COMMUNITIES])
+  @Query(() => [Community])
+  async getCommunitySelections(): Promise<Community[]> {
+    const dbCommunities: DbCommunity[] = await DbCommunity.find({
+      order: {
+        name: 'ASC',
+      },
+    })
     return dbCommunities.map((dbCom: DbCommunity) => new Community(dbCom))
   }
 }

database/entity/0065-refactor_communities_table/Community.ts

@@ -0,0 +1,60 @@
+import {
+  BaseEntity,
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn,
+} from 'typeorm'
+
+@Entity('communities')
+export class Community extends BaseEntity {
+  @PrimaryGeneratedColumn('increment', { unsigned: true })
+  id: number
+
+  @Column({ name: 'foreign', type: 'bool', nullable: false, default: true })
+  foreign: boolean
+
+  @Column({ name: 'url', length: 255, nullable: false })
+  url: string
+
+  @Column({ name: 'public_key', type: 'binary', length: 64, nullable: false })
+  publicKey: Buffer
+
+  @Column({
+    name: 'community_uuid',
+    type: 'char',
+    length: 36,
+    nullable: true,
+    collation: 'utf8mb4_unicode_ci',
+  })
+  communityUuid: string | null
+
+  @Column({ name: 'authenticated_at', type: 'datetime', nullable: true })
+  authenticatedAt: Date | null
+
+  @Column({ name: 'name', type: 'varchar', length: 40, nullable: true })
+  name: string | null
+
+  @Column({ name: 'description', type: 'varchar', length: 255, nullable: true })
+  description: string | null
+
+  @CreateDateColumn({ name: 'creation_date', type: 'datetime', nullable: true })
+  creationDate: Date | null
+
+  @CreateDateColumn({
+    name: 'created_at',
+    type: 'datetime',
+    default: () => 'CURRENT_TIMESTAMP(3)',
+    nullable: false,
+  })
+  createdAt: Date
+
+  @UpdateDateColumn({
+    name: 'updated_at',
+    type: 'datetime',
+    onUpdate: 'CURRENT_TIMESTAMP(3)',
+    nullable: true,
+  })
+  updatedAt: Date | null
+}

database/entity/0065-refactor_communities_table/FederatedCommunity.ts

@@ -0,0 +1,51 @@
+import {
+  BaseEntity,
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn,
+} from 'typeorm'
+
+@Entity('federated_communities')
+export class FederatedCommunity extends BaseEntity {
+  @PrimaryGeneratedColumn('increment', { unsigned: true })
+  id: number
+
+  @Column({ name: 'foreign', type: 'bool', nullable: false, default: true })
+  foreign: boolean
+
+  @Column({ name: 'public_key', type: 'binary', length: 64, default: null, nullable: true })
+  publicKey: Buffer
+
+  @Column({ name: 'api_version', length: 10, nullable: false })
+  apiVersion: string
+
+  @Column({ name: 'end_point', length: 255, nullable: false })
+  endPoint: string
+
+  @Column({ name: 'last_announced_at', type: 'datetime', nullable: true })
+  lastAnnouncedAt: Date | null
+
+  @Column({ name: 'verified_at', type: 'datetime', nullable: true })
+  verifiedAt: Date | null
+
+  @Column({ name: 'last_error_at', type: 'datetime', nullable: true })
+  lastErrorAt: Date | null
+
+  @CreateDateColumn({
+    name: 'created_at',
+    type: 'datetime',
+    default: () => 'CURRENT_TIMESTAMP(3)',
+    nullable: false,
+  })
+  createdAt: Date
+
+  @UpdateDateColumn({
+    name: 'updated_at',
+    type: 'datetime',
+    onUpdate: 'CURRENT_TIMESTAMP(3)',
+    nullable: true,
+  })
+  updatedAt: Date | null
+}

database/entity/Community.ts

@@ -1 +1 @@
-export { Community } from './0060-update_communities_table/Community'
+export { Community } from './0065-refactor_communities_table/Community'

database/entity/FederatedCommunity.ts

@@ -0,0 +1 @@
+export { FederatedCommunity } from './0065-refactor_communities_table/FederatedCommunity'

database/entity/index.ts

@@ -10,6 +10,7 @@ import { Contribution } from './Contribution'
 import { Event } from './Event'
 import { ContributionMessage } from './ContributionMessage'
 import { Community } from './Community'
+import { FederatedCommunity } from './FederatedCommunity'
 
 export const entities = [
   Community,
@@ -17,6 +18,7 @@ export const entities = [
   ContributionLink,
   ContributionMessage,
   Event,
+  FederatedCommunity,
   LoginElopageBuys,
   LoginEmailOptIn,
   Migration,

database/migrations/0065-refactor_communities_table.ts

@@ -0,0 +1,36 @@
+/* MIGRATION TO CREATE THE FEDERATION COMMUNITY TABLES
+ *
+ * This migration creates the `community` and 'communityfederation' tables in the `apollo` database (`gradido_community`).
+ */
+
+/* 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(`RENAME TABLE communities TO federated_communities;`)
+  await queryFn(`
+    CREATE TABLE communities (
+      \`id\` int unsigned NOT NULL AUTO_INCREMENT,
+      \`foreign\` tinyint(4) NOT NULL DEFAULT 1,
+      \`url\` varchar(255) NOT NULL,
+      \`public_key\` binary(64) NOT NULL,
+      \`community_uuid\` char(36) NULL,
+      \`authenticated_at\` datetime(3) NULL,
+      \`name\` varchar(40) NULL,
+      \`description\` varchar(255) NULL,
+      \`creation_date\` datetime(3) NULL,
+      \`created_at\` datetime(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+      \`updated_at\` datetime(3),
+      PRIMARY KEY (id),
+      UNIQUE KEY url_key (url),
+      UNIQUE KEY uuid_key (community_uuid),
+      UNIQUE KEY public_key_key (public_key)
+    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
+  `)
+}
+
+export async function downgrade(queryFn: (query: string, values?: any[]) => Promise<Array<any>>) {
+  // write downgrade logic as parameter of queryFn
+  await queryFn(`DROP TABLE communities;`)
+  await queryFn(`RENAME TABLE federated_communities TO communities;`)
+}

dht-node/src/config/index.ts

@@ -3,7 +3,7 @@ import dotenv from 'dotenv'
 dotenv.config()
 
 const constants = {
-  DB_VERSION: '0064-event_rename',
+  DB_VERSION: '0065-refactor_communities_table',
   LOG4JS_CONFIG: 'log4js-config.json',
   // default log level on production should be info
   LOG_LEVEL: process.env.LOG_LEVEL || 'info',

dht-node/src/dht_node/index.test.ts

@@ -5,7 +5,7 @@ import { startDHT } from './index'
 import DHT from '@hyperswarm/dht'
 import CONFIG from '@/config'
 import { logger } from '@test/testSetup'
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 import { testEnvironment, cleanDB } from '@test/helpers'
 
 CONFIG.FEDERATION_DHT_SEED = '64ebcb0e3ad547848fef4197c6e2332f'
@@ -261,7 +261,7 @@ describe('federation', () => {
 
             describe('with receiving wrong but tolerated property data', () => {
               let jsonArray: any[]
-              let result: DbCommunity[] = []
+              let result: DbFederatedCommunity[] = []
               beforeAll(async () => {
                 jest.clearAllMocks()
                 jsonArray = [
@@ -277,7 +277,7 @@ describe('federation', () => {
                   },
                 ]
                 await socketEventMocks.data(Buffer.from(JSON.stringify(jsonArray)))
-                result = await DbCommunity.find({ foreign: true })
+                result = await DbFederatedCommunity.find({ foreign: true })
               })
 
               afterAll(async () => {
@@ -523,7 +523,7 @@ describe('federation', () => {
 
             describe('with receiving data of exact max allowed properties length', () => {
               let jsonArray: any[]
-              let result: DbCommunity[] = []
+              let result: DbFederatedCommunity[] = []
               beforeAll(async () => {
                 jest.clearAllMocks()
                 jsonArray = [
@@ -538,7 +538,7 @@ describe('federation', () => {
                   { api: 'toolong api', url: 'some valid url' },
                 ]
                 await socketEventMocks.data(Buffer.from(JSON.stringify(jsonArray)))
-                result = await DbCommunity.find({ foreign: true })
+                result = await DbFederatedCommunity.find({ foreign: true })
               })
 
               afterAll(async () => {
@@ -570,7 +570,7 @@ describe('federation', () => {
 
             describe('with receiving data of exact max allowed buffer length', () => {
               let jsonArray: any[]
-              let result: DbCommunity[] = []
+              let result: DbFederatedCommunity[] = []
               beforeAll(async () => {
                 jest.clearAllMocks()
                 jsonArray = [
@@ -592,7 +592,7 @@ describe('federation', () => {
                   },
                 ]
                 await socketEventMocks.data(Buffer.from(JSON.stringify(jsonArray)))
-                result = await DbCommunity.find({ foreign: true })
+                result = await DbFederatedCommunity.find({ foreign: true })
               })
 
               afterAll(async () => {
@@ -711,7 +711,7 @@ describe('federation', () => {
             })
 
             describe('with proper data', () => {
-              let result: DbCommunity[] = []
+              let result: DbFederatedCommunity[] = []
               beforeAll(async () => {
                 jest.clearAllMocks()
                 await socketEventMocks.data(
@@ -728,7 +728,7 @@ describe('federation', () => {
                     ]),
                   ),
                 )
-                result = await DbCommunity.find({ foreign: true })
+                result = await DbFederatedCommunity.find({ foreign: true })
               })
 
               afterAll(async () => {

dht-node/src/dht_node/index.ts

@@ -3,7 +3,7 @@
 import DHT from '@hyperswarm/dht'
 import { logger } from '@/server/logger'
 import CONFIG from '@/config'
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 
 const KEY_SECRET_SEEDBYTES = 32
 const getSeed = (): Buffer | null =>
@@ -31,7 +31,7 @@ export const startDHT = async (topic: string): Promise<void> => {
     logger.info(`keyPairDHT: publicKey=${keyPair.publicKey.toString('hex')}`)
     logger.debug(`keyPairDHT: secretKey=${keyPair.secretKey.toString('hex')}`)
 
-    const ownApiVersions = await writeHomeCommunityEnries(keyPair.publicKey)
+    const ownApiVersions = await writeFederatedHomeCommunityEnries(keyPair.publicKey)
     logger.info(`ApiList: ${JSON.stringify(ownApiVersions)}`)
 
     const node = new DHT({ keyPair })
@@ -92,9 +92,9 @@ export const startDHT = async (topic: string): Promise<void> => {
             }
             logger.debug(`upsert with variables=${JSON.stringify(variables)}`)
             // this will NOT update the updatedAt column, to distingue between a normal update and the last announcement
-            await DbCommunity.createQueryBuilder()
+            await DbFederatedCommunity.createQueryBuilder()
               .insert()
-              .into(DbCommunity)
+              .into(DbFederatedCommunity)
               .values(variables)
               .orUpdate({
                 conflict_target: ['id', 'publicKey', 'apiVersion'],
@@ -179,7 +179,7 @@ export const startDHT = async (topic: string): Promise<void> => {
   }
 }
 
-async function writeHomeCommunityEnries(pubKey: any): Promise<CommunityApi[]> {
+async function writeFederatedHomeCommunityEnries(pubKey: any): Promise<CommunityApi[]> {
   const homeApiVersions: CommunityApi[] = Object.values(ApiVersionType).map(function (apiEnum) {
     const comApi: CommunityApi = {
       api: apiEnum,
@@ -189,17 +189,17 @@ async function writeHomeCommunityEnries(pubKey: any): Promise<CommunityApi[]> {
   })
   try {
     // first remove privious existing homeCommunity entries
-    DbCommunity.createQueryBuilder().delete().where({ foreign: false }).execute()
+    DbFederatedCommunity.createQueryBuilder().delete().where({ foreign: false }).execute()
 
     homeApiVersions.forEach(async function (homeApi) {
-      const homeCom = new DbCommunity()
+      const homeCom = new DbFederatedCommunity()
       homeCom.foreign = false
       homeCom.apiVersion = homeApi.api
       homeCom.endPoint = homeApi.url
       homeCom.publicKey = pubKey.toString('hex')
 
       // this will NOT update the updatedAt column, to distingue between a normal update and the last announcement
-      await DbCommunity.insert(homeCom)
+      await DbFederatedCommunity.insert(homeCom)
       logger.info(`federation home-community inserted successfully: ${JSON.stringify(homeCom)}`)
     })
   } catch (err) {

docu/Concepts/TechnicalRequirements/Federation.md

@@ -50,6 +50,52 @@ Before starting in describing the details of the federation handshake, some prer
 
 With the federation additional data tables/entities have to be created.
 
+##### 1st Draft
+
+The following diagramms shows the first draft of the possible database-model base on the migration 0063-event_link_fields.ts with 3 steps of migration to reach the required entities. All three diagramms are not exhaustive and are still a base for discussions:
+
+![img](./image/classdiagramm_x-community-readyness_step1.svg)
+
+In the first step the current communities table will be renamed to communities_federation. A new table communities is created. Because of the dynamic in the communities_federation data during dht-federation the relation between both entities will be on the collumn communities.communities_federation_public_key. This relation will allow to read a community-entry including its relation to the multi federation entries per api-version with the public key as identifier.
+
+![img](./image/classdiagramm_x-community-readyness_step2.svg)
+
+The 2nd step is an introduction of the entity accounts between the users and the transactions table. This will cause a separation of the transactions from the users, to avoid possible conflicts or dependencies between local users of the community and remote users of foreign users, who will be part of x-communitiy-transactions.
+
+![img](./image/classdiagramm_x-community-readyness_step3.svg)
+
+The 3rd step will introduce an additional foreign-users and a users_favorites table. A foreign_user could be stored in the existing users-table, but he will not need all the attributes of a home-user, especially he will never gets an AGE-account in this community. The user_favorites entity is designed to buildup the relations between users and foreign_users or in general between all users. This is simply a first idea for a future discussion.
+
+##### 2nd Draft
+
+After team discussion in architecture meeting a second vision draft for database migration is shown in the following picture. Only the concerned tables of the database migration are presented. The three elliptical surroundings shows the different steps, which should be done in separate issues. The model, table namings and columns are not exhaustive and are still a base for further discussions.
+
+![img](./image/class-diagramm_vision-draft2.svg)
+
+**The first step** with renaming the current `communities` table in `communities_federation` and creating a new `communities` table is not changed. More details about motivation and arguments are described above.
+
+**The second step** is changed to migrate the `users `table by creating a new `users_settings` table and shift the most existing attributes from `users `table to it. The criterium for shifting a column to `user_settings` is to keep only those columns in the `users `table, which will be used for "home-users" and "foreign-users". A foreign-user at this point of time is a user of an other community, who is involved in a x-community-transaction as `linked_user`. He will not have the possibility to login to the home-community, because after a x-community-tx only the attributes of the `users `table will be exchanged during the handshake of transaction processing of both communities. Even the `transactions `table will be ready for x-community-tx with this `users `and `user_settings` migration, because it contains a reference to both participants of the transaction. For easier displaying and because of historical reasons it will be a good idea to add the columns `linked_user `and `user `(not shown in diagramm) to the `transactions `table with type varchar(512) to store the valid firstname and lastname of the participants at transaction-date. If one of the participants will change his names, there will be no migration of the transaction data necessary and a transaction-list will present always the currect names even over a long distance.
+
+**The third step** contains a migration for handling accounts and user_correlations. With the new table `gdd_accounts `a new entity will be introduced to support the different types of gradido accounts AGE, GMW and AUF. The second new table `user_correlations `is to buildup the different correlations a user will have:
+
+* user to user correlation like favorites, trustee, etc
+* user to account correlation for cashier of a GMW and AUF community account, trustee of children or seniors, etc.
+
+The previous idea to replace the `user_id `with an `account_id` in the `transactions `table will be not necessary with this draft, because it will not cause a benefit and saves a lot refactoring efforts.
+
+##### 3rd Draft
+
+After further discussions about the database-model and the necessary migration steps the team decided to integrate an additional migration step for X-Community-Transaction. The decision base on keeping the goal focus on implementation of the x-community sendCoins feature as soon as possible.
+
+![img](./image/class-diagramm_vision-draft3.svg)
+
+The additional migration step 2 will simply concentrated on the `transactions `table by adding all necessary columns to handle a *x-community-tx* without a previous migration of the `users `table, shown as step 3 in the picture above.
+
+In concequence of these additional columns in the `transactions `table the database-model will be denormalized by containing redundanten columns. But this migration step will reduce the necessary efforts to reach the *x-community sendCoins* feature as soon as possible. On the other side it offers more possibilities to ensure data consitency, because of internal data checks in conjunction with the redundant columns.
+
+The feature *x-community-tx* per *sendCoins* will create several challenges, because there is no technical transaction bracket, which will ensure consistent data in both community databases after all write access are finished. The most favorite concept about handling a x-community-transaction and the upcoming handshake to ensure valid send- and receive-transaction entries in both databases is to follow the two-phase-commit protocol. To avoid blocking the transactions table or user dependent transactions-entries during the two-phase-commit processing the idea of pending_transactions is born. This additional pending_transactions table contains the same columns than the transactions table plus one column named `x_transactions_state`.
+
+
 ##### Community-Entity
 
 Create the new *Community* table to store attributes of the own community. This table is used more like a frame for own community data in the future like the list of federated foreign communities, own users, own futher accounts like AUF- and  Welfare-account and the profile data of the own community:

federation/src/config/index.ts

@@ -11,7 +11,7 @@ Decimal.set({
 */
 
 const constants = {
-  DB_VERSION: '0064-event_rename',
+  DB_VERSION: '0065-refactor_communities_table',
   // 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

federation/src/graphql/api/1_0/resolver/PublicKeyResolver.test.ts

@@ -2,7 +2,7 @@
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 import { createTestClient } from 'apollo-server-testing'
 import createServer from '@/server/createServer'
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 
 let query: any
 
@@ -13,7 +13,7 @@ beforeAll(async () => {
   const server = await createServer()
   con = server.con
   query = createTestClient(server.apollo).query
-  DbCommunity.clear()
+  DbFederatedCommunity.clear()
 })
 
 afterAll(async () => {
@@ -32,12 +32,12 @@ describe('PublicKeyResolver', () => {
 
   describe('getPublicKey', () => {
     beforeEach(async () => {
-      const homeCom = new DbCommunity()
+      const homeCom = new DbFederatedCommunity()
       homeCom.foreign = false
       homeCom.apiVersion = '1_0'
       homeCom.endPoint = 'endpoint-url'
       homeCom.publicKey = Buffer.from('homeCommunity-publicKey')
-      await DbCommunity.insert(homeCom)
+      await DbFederatedCommunity.insert(homeCom)
     })
 
     it('returns homeCommunity-publicKey', async () => {

federation/src/graphql/api/1_0/resolver/PublicKeyResolver.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { Query, Resolver } from 'type-graphql'
 import { federationLogger as logger } from '@/server/logger'
-import { Community as DbCommunity } from '@entity/Community'
+import { FederatedCommunity as DbFederatedCommunity } from '@entity/FederatedCommunity'
 import { GetPublicKeyResult } from '../model/GetPublicKeyResult'
 
 @Resolver()
@@ -10,7 +10,7 @@ export class PublicKeyResolver {
   @Query(() => GetPublicKeyResult)
   async getPublicKey(): Promise<GetPublicKeyResult> {
     logger.debug(`getPublicKey() via apiVersion=1_0 ...`)
-    const homeCom = await DbCommunity.findOneOrFail({
+    const homeCom = await DbFederatedCommunity.findOneOrFail({
       foreign: false,
       apiVersion: '1_0',
     })