Merge pull request #1762 from gradido/define-context-object

refactor: Define Context Interface

backend/src/graphql/resolver/AdminResolver.ts

@@ -1,6 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-
+import { Context, getUser } from '@/server/context'
 import { Resolver, Query, Arg, Args, Authorized, Mutation, Ctx, Int } from 'type-graphql'
 import {
   getCustomRepository,
@@ -137,7 +135,7 @@ export class AdminResolver {
   @Mutation(() => Date, { nullable: true })
   async deleteUser(
     @Arg('userId', () => Int) userId: number,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<Date | null> {
     const user = await dbUser.findOne({ id: userId })
     // user exists ?
@@ -145,7 +143,7 @@ export class AdminResolver {
       throw new Error(`Could not find user with userId: ${userId}`)
     }
     // moderator user disabled own account?
-    const moderatorUser = context.user
+    const moderatorUser = getUser(context)
     if (moderatorUser.id === userId) {
       throw new Error('Moderator can not delete his own account!')
     }
@@ -309,10 +307,10 @@ export class AdminResolver {
   @Mutation(() => Boolean)
   async confirmPendingCreation(
     @Arg('id', () => Int) id: number,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<boolean> {
     const pendingCreation = await AdminPendingCreation.findOneOrFail(id)
-    const moderatorUser = context.user
+    const moderatorUser = getUser(context)
     if (moderatorUser.id === pendingCreation.userId)
       throw new Error('Moderator can not confirm own pending creation')
 

backend/src/graphql/resolver/BalanceResolver.ts

@@ -1,6 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-
+import { Context, getUser } from '@/server/context'
 import { Resolver, Query, Ctx, Authorized } from 'type-graphql'
 import { Balance } from '@model/Balance'
 import { calculateDecay } from '@/util/decay'
@@ -16,8 +14,8 @@ import { TransactionLinkRepository } from '@repository/TransactionLink'
 export class BalanceResolver {
   @Authorized([RIGHTS.BALANCE])
   @Query(() => Balance)
-  async balance(@Ctx() context: any): Promise<Balance> {
-    const { user } = context
+  async balance(@Ctx() context: Context): Promise<Balance> {
+    const user = getUser(context)
     const now = new Date()
 
     const gdtResolver = new GdtResolver()

backend/src/graphql/resolver/CommunityResolver.ts

@@ -1,6 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-
 import { Resolver, Query, Authorized } from 'type-graphql'
 import { RIGHTS } from '@/auth/RIGHTS'
 import CONFIG from '@/config'

backend/src/graphql/resolver/GdtResolver.ts

@@ -1,6 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-
+import { Context, getUser } from '@/server/context'
 import { Resolver, Query, Args, Ctx, Authorized, Arg } from 'type-graphql'
 import CONFIG from '@/config'
 import { GdtEntryList } from '@model/GdtEntryList'
@@ -16,9 +14,9 @@ export class GdtResolver {
   async listGDTEntries(
     @Args()
     { currentPage = 1, pageSize = 5, order = Order.DESC }: Paginated,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<GdtEntryList> {
-    const userEntity = context.user
+    const userEntity = getUser(context)
 
     try {
       const resultGDT = await apiGet(
@@ -28,15 +26,15 @@ export class GdtResolver {
         throw new Error(resultGDT.data)
       }
       return new GdtEntryList(resultGDT.data)
-    } catch (err: any) {
+    } catch (err) {
       throw new Error('GDT Server is not reachable.')
     }
   }
 
   @Authorized([RIGHTS.GDT_BALANCE])
   @Query(() => Number)
-  async gdtBalance(@Ctx() context: any): Promise<number | null> {
-    const { user } = context
+  async gdtBalance(@Ctx() context: Context): Promise<number | null> {
+    const user = getUser(context)
     try {
       const resultGDTSum = await apiPost(`${CONFIG.GDT_API_URL}/GdtEntries/sumPerEmailApi`, {
         email: user.email,
@@ -45,9 +43,9 @@ export class GdtResolver {
         throw new Error('Call not successful')
       }
       return Number(resultGDTSum.data.sum) || 0
-    } catch (err: any) {
+    } catch (err) {
       // eslint-disable-next-line no-console
-      console.log('Could not query GDT Server', err)
+      console.log('Could not query GDT Server')
       return null
     }
   }

backend/src/graphql/resolver/KlicktippResolver.ts

@@ -1,6 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-
 import { Resolver, Query, Authorized, Arg, Mutation, Args } from 'type-graphql'
 import {
   getKlickTippUser,

backend/src/graphql/resolver/TransactionLinkResolver.ts

@@ -1,6 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-
+import { Context, getUser } from '@/server/context'
 import { Resolver, Args, Arg, Authorized, Ctx, Mutation, Query, Int } from 'type-graphql'
 import { TransactionLink } from '@model/TransactionLink'
 import { TransactionLink as dbTransactionLink } from '@entity/TransactionLink'
@@ -38,9 +36,9 @@ export class TransactionLinkResolver {
   @Mutation(() => TransactionLink)
   async createTransactionLink(
     @Args() { amount, memo }: TransactionLinkArgs,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<TransactionLink> {
-    const { user } = context
+    const user = getUser(context)
 
     const createdDate = new Date()
     const validUntil = transactionLinkExpireDate(createdDate)
@@ -72,9 +70,9 @@ export class TransactionLinkResolver {
   @Mutation(() => Boolean)
   async deleteTransactionLink(
     @Arg('id', () => Int) id: number,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<boolean> {
-    const { user } = context
+    const user = getUser(context)
 
     const transactionLink = await dbTransactionLink.findOne({ id })
     if (!transactionLink) {
@@ -113,9 +111,9 @@ export class TransactionLinkResolver {
   async listTransactionLinks(
     @Args()
     { currentPage = 1, pageSize = 5, order = Order.DESC }: Paginated,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<TransactionLink[]> {
-    const { user } = context
+    const user = getUser(context)
     // const now = new Date()
     const transactionLinks = await dbTransactionLink.find({
       where: {
@@ -136,9 +134,9 @@ export class TransactionLinkResolver {
   @Mutation(() => Boolean)
   async redeemTransactionLink(
     @Arg('code', () => String) code: string,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<boolean> {
-    const { user } = context
+    const user = getUser(context)
     const transactionLink = await dbTransactionLink.findOneOrFail({ code })
     const linkedUser = await dbUser.findOneOrFail({ id: transactionLink.userId })
 

backend/src/graphql/resolver/TransactionResolver.ts

@@ -1,8 +1,7 @@
 /* eslint-disable new-cap */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
+import { Context, getUser } from '@/server/context'
 import { Resolver, Query, Args, Authorized, Ctx, Mutation } from 'type-graphql'
 import { getCustomRepository, getConnection } from '@dbTools/typeorm'
 
@@ -147,10 +146,10 @@ export class TransactionResolver {
   async transactionList(
     @Args()
     { currentPage = 1, pageSize = 25, order = Order.DESC }: Paginated,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<TransactionList> {
     const now = new Date()
-    const user = context.user
+    const user = getUser(context)
 
     // find current balance
     const lastTransaction = await dbTransaction.findOne(
@@ -247,10 +246,10 @@ export class TransactionResolver {
   @Mutation(() => String)
   async sendCoins(
     @Args() { email, amount, memo }: TransactionSendArgs,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<boolean> {
     // TODO this is subject to replay attacks
-    const senderUser = context.user
+    const senderUser = getUser(context)
     if (senderUser.pubKey.length !== 32) {
       throw new Error('invalid sender public key')
     }

backend/src/graphql/resolver/UserResolver.ts

@@ -1,7 +1,5 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-
 import fs from 'fs'
+import { Context, getUser } from '@/server/context'
 import { Resolver, Query, Args, Arg, Authorized, Ctx, UseMiddleware, Mutation } from 'type-graphql'
 import { getConnection, getCustomRepository } from '@dbTools/typeorm'
 import CONFIG from '@/config'
@@ -192,9 +190,9 @@ export class UserResolver {
   @Authorized([RIGHTS.VERIFY_LOGIN])
   @Query(() => User)
   @UseMiddleware(klicktippNewsletterStateMiddleware)
-  async verifyLogin(@Ctx() context: any): Promise<User> {
+  async verifyLogin(@Ctx() context: Context): Promise<User> {
     // TODO refactor and do not have duplicate code with login(see below)
-    const userEntity = context.user
+    const userEntity = getUser(context)
     const user = new User(userEntity)
     // user.pubkey = userEntity.pubKey.toString('hex')
     // Elopage Status & Stored PublisherId
@@ -218,7 +216,7 @@ export class UserResolver {
   @UseMiddleware(klicktippNewsletterStateMiddleware)
   async login(
     @Args() { email, password, publisherId }: UnsecureLoginArgs,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<User> {
     email = email.trim().toLowerCase()
     const dbUser = await DbUser.findOneOrFail({ email }, { withDeleted: true }).catch(() => {
@@ -540,9 +538,9 @@ export class UserResolver {
       passwordNew,
       coinanimation,
     }: UpdateUserInfosArgs,
-    @Ctx() context: any,
+    @Ctx() context: Context,
   ): Promise<boolean> {
-    const userEntity = context.user
+    const userEntity = getUser(context)
 
     if (firstName) {
       userEntity.firstName = firstName
@@ -619,7 +617,7 @@ export class UserResolver {
 
   @Authorized([RIGHTS.HAS_ELOPAGE])
   @Query(() => Boolean)
-  async hasElopage(@Ctx() context: any): Promise<boolean> {
+  async hasElopage(@Ctx() context: Context): Promise<boolean> {
     const userEntity = context.user
     if (!userEntity) {
       return false

backend/src/server/context.ts

@@ -1,9 +1,24 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+import { Role } from '@/auth/Role'
+import { User as dbUser } from '@entity/User'
+import { Transaction as dbTransaction } from '@entity/Transaction'
+import Decimal from 'decimal.js-light'
+import { ExpressContext } from 'apollo-server-express'
 
-const context = (args: any) => {
+export interface Context {
+  token: string | null
+  setHeaders: { key: string; value: string }[]
+  role?: Role
+  user?: dbUser
+  // hack to use less DB calls for Balance Resolver
+  lastTransaction?: dbTransaction
+  transactionCount?: number
+  linkCount?: number
+  sumHoldAvailableAmount?: Decimal
+}
+
+const context = (args: ExpressContext): Context => {
   const authorization = args.req.headers.authorization
-  let token = null
+  let token: string | null = null
   if (authorization) {
     token = authorization.replace(/^Bearer /, '')
   }
@@ -14,4 +29,9 @@ const context = (args: any) => {
   return context
 }
 
+export const getUser = (context: Context): dbUser => {
+  if (context.user) return context.user
+  throw new Error('No user given in context!')
+}
+
 export default context