diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index cc273e991..56b5869ee 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -441,7 +441,7 @@ jobs: report_name: Coverage Admin Interface type: lcov result_path: ./coverage/lcov.info - min_coverage: 50 + min_coverage: 53 token: ${{ github.token }} ############################################################################## diff --git a/README.md b/README.md index ead54701c..ce8e84df0 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,22 @@ We are currently restructuring the service to reduce dependencies and unify busi Once you have `docker-compose` up and running, you can open [http://localhost/vue](http://localhost/vue) and create yourself a new wallet account. +## How to release + +A release is tagged on Github by its version number and published as github release. This is done automatically when a new version is defined in the [package.json](./package.json) and merged into master - furthermore we set all our sub-package-versions to the same version as the main package.json version to make version management as simple as possible. +Each release is accompanied with release notes automatically generated from the git log which is available as [CHANGELOG.md](./CHANGELOG.md). + +To generate the Changelog and set a new Version you should use the following commands in the main folder +```bash +git fetch --all +yarn release +``` + +The first command `git fetch --all` will make sure you have all tags previously defined which is required to generate a correct changelog. The second command `yarn release` will execute the changelog tool and set version numbers in the main package and sub-packages. It is required to do `yarn install` before you can use this command. +After generating a new version you should commit the changes. This will be the CHANGELOG.md and several package.json files. This commit will be omitted in the changelog. + +Note: The Changelog will be regenerated with all tags on release on the external builder tool, but will not be checked in there. The Changelog on the github release will therefore always be correct, on the repo it might be incorrect due to missing tags when executing the `yarn release` command. + ## Troubleshooting | Problem | Issue | Solution | Description | diff --git a/admin/src/graphql/getCountPendingCreations.js b/admin/src/graphql/getCountPendingCreations.js new file mode 100644 index 000000000..f8593ee59 --- /dev/null +++ b/admin/src/graphql/getCountPendingCreations.js @@ -0,0 +1,7 @@ +import gql from 'graphql-tag' + +export const countPendingCreations = gql` + query { + countPendingCreations + } +` diff --git a/admin/src/graphql/getPendingCreations.js b/admin/src/graphql/getPendingCreations.js new file mode 100644 index 000000000..a94172d43 --- /dev/null +++ b/admin/src/graphql/getPendingCreations.js @@ -0,0 +1,16 @@ +import gql from 'graphql-tag' + +export const getPendingCreations = gql` + query { + getPendingCreations { + firstName + lastName + email + amount + memo + date + moderator + creation + } + } +` diff --git a/admin/src/graphql/verifyLogin.js b/admin/src/graphql/verifyLogin.js index 59f5e7eb1..553557f3c 100644 --- a/admin/src/graphql/verifyLogin.js +++ b/admin/src/graphql/verifyLogin.js @@ -5,6 +5,7 @@ export const verifyLogin = gql` verifyLogin { firstName lastName + isAdmin id } } diff --git a/admin/src/main.js b/admin/src/main.js index e6f5a80e1..6a59f1cc7 100644 --- a/admin/src/main.js +++ b/admin/src/main.js @@ -75,7 +75,7 @@ Vue.use(Toasted, { }, }) -addNavigationGuards(router, store) +addNavigationGuards(router, store, apolloProvider.defaultClient) new Vue({ moment, diff --git a/admin/src/pages/CreationConfirm.spec.js b/admin/src/pages/CreationConfirm.spec.js index caf94cd37..86f90231b 100644 --- a/admin/src/pages/CreationConfirm.spec.js +++ b/admin/src/pages/CreationConfirm.spec.js @@ -4,11 +4,47 @@ import CreationConfirm from './CreationConfirm.vue' const localVue = global.localVue const storeCommitMock = jest.fn() +const toastedErrorMock = jest.fn() +const apolloQueryMock = jest.fn().mockResolvedValue({ + data: { + getPendingCreations: [ + { + firstName: 'Bibi', + lastName: 'Bloxberg', + email: 'bibi@bloxberg.de', + amount: 500, + memo: 'Danke für alles', + date: new Date(), + moderator: 0, + }, + { + firstName: 'Räuber', + lastName: 'Hotzenplotz', + email: 'raeuber@hotzenplotz.de', + amount: 1000000, + memo: 'Gut Ergatert', + date: new Date(), + moderator: 0, + }, + ], + }, +}) const mocks = { $store: { commit: storeCommitMock, }, + $apollo: { + query: apolloQueryMock, + }, + $toasted: { + error: toastedErrorMock, + }, + $moment: jest.fn((value) => { + return { + format: jest.fn((format) => value), + } + }), } describe('CreationConfirm', () => { @@ -32,9 +68,22 @@ describe('CreationConfirm', () => { it('commits resetOpenCreations to store', () => { expect(storeCommitMock).toBeCalledWith('resetOpenCreations') }) + it('commits setOpenCreations to store', () => { + expect(storeCommitMock).toBeCalledWith('setOpenCreations', 2) + }) + }) - it('commits openCreationsPlus to store', () => { - expect(storeCommitMock).toBeCalledWith('openCreationsPlus', 5) + describe('server response is error', () => { + beforeEach(() => { + jest.clearAllMocks() + apolloQueryMock.mockRejectedValue({ + message: 'Ouch!', + }) + wrapper = Wrapper() + }) + + it('toast an error message', () => { + expect(toastedErrorMock).toBeCalledWith('Ouch!') }) }) diff --git a/admin/src/pages/CreationConfirm.vue b/admin/src/pages/CreationConfirm.vue index 0d68635e0..3aef891eb 100644 --- a/admin/src/pages/CreationConfirm.vue +++ b/admin/src/pages/CreationConfirm.vue @@ -1,9 +1,5 @@ diff --git a/admin/src/router/guards.js b/admin/src/router/guards.js index d59234a25..4ed6c8516 100644 --- a/admin/src/router/guards.js +++ b/admin/src/router/guards.js @@ -1,12 +1,28 @@ +import { verifyLogin } from '../graphql/verifyLogin' import CONFIG from '../config' -const addNavigationGuards = (router, store) => { +const addNavigationGuards = (router, store, apollo) => { // store token on `authenticate` - router.beforeEach((to, from, next) => { + router.beforeEach(async (to, from, next) => { if (to.path === '/authenticate' && to.query && to.query.token) { - // TODO verify user to get user data store.commit('token', to.query.token) - next({ path: '/' }) + await apollo + .query({ + query: verifyLogin, + fetchPolicy: 'network-only', + }) + .then((result) => { + const moderator = result.data.verifyLogin + if (moderator.isAdmin) { + store.commit('moderator', moderator) + next({ path: '/' }) + } else { + next({ path: '/not-found' }) + } + }) + .catch(() => { + next({ path: '/not-found' }) + }) } else { next() } @@ -16,7 +32,9 @@ const addNavigationGuards = (router, store) => { router.beforeEach((to, from, next) => { if ( !CONFIG.DEBUG_DISABLE_AUTH && // we did not disabled the auth module for debug purposes - !store.state.token && // we do not have a token + (!store.state.token || // we do not have a token + !store.state.moderator || // no moderator set in store + !store.state.moderator.isAdmin) && // user is no admin to.path !== '/not-found' && // we are not on `not-found` to.path !== '/logout' // we are not on `logout` ) { diff --git a/admin/src/router/guards.test.js b/admin/src/router/guards.test.js index e69846aab..cd5b33e68 100644 --- a/admin/src/router/guards.test.js +++ b/admin/src/router/guards.test.js @@ -2,6 +2,13 @@ import addNavigationGuards from './guards' import router from './router' const storeCommitMock = jest.fn() +const apolloQueryMock = jest.fn().mockResolvedValue({ + data: { + verifyLogin: { + isAdmin: true, + }, + }, +}) const store = { commit: storeCommitMock, @@ -10,7 +17,11 @@ const store = { }, } -addNavigationGuards(router, store) +const apollo = { + query: apolloQueryMock, +} + +addNavigationGuards(router, store, apollo) describe('navigation guards', () => { beforeEach(() => { @@ -21,18 +32,70 @@ describe('navigation guards', () => { const navGuard = router.beforeHooks[0] const next = jest.fn() - describe('with valid token', () => { - it('commits the token to the store', async () => { + describe('with valid token and as admin', () => { + beforeEach(() => { navGuard({ path: '/authenticate', query: { token: 'valid-token' } }, {}, next) + }) + + it('commits the token to the store', async () => { expect(storeCommitMock).toBeCalledWith('token', 'valid-token') }) + it('commits the moderator to the store', () => { + expect(storeCommitMock).toBeCalledWith('moderator', { isAdmin: true }) + }) + it('redirects to /', async () => { - navGuard({ path: '/authenticate', query: { token: 'valid-token' } }, {}, next) expect(next).toBeCalledWith({ path: '/' }) }) }) + describe('with valid token and not as admin', () => { + beforeEach(() => { + apolloQueryMock.mockResolvedValue({ + data: { + verifyLogin: { + isAdmin: false, + }, + }, + }) + navGuard({ path: '/authenticate', query: { token: 'valid-token' } }, {}, next) + }) + + it('commits the token to the store', async () => { + expect(storeCommitMock).toBeCalledWith('token', 'valid-token') + }) + + it('does not commit the moderator to the store', () => { + expect(storeCommitMock).not.toBeCalledWith('moderator', { isAdmin: false }) + }) + + it('redirects to /not-found', async () => { + expect(next).toBeCalledWith({ path: '/not-found' }) + }) + }) + + describe('with valid token and server error on verification', () => { + beforeEach(() => { + apolloQueryMock.mockRejectedValue({ + message: 'Ouch!', + }) + navGuard({ path: '/authenticate', query: { token: 'valid-token' } }, {}, next) + }) + + it('commits the token to the store', async () => { + expect(storeCommitMock).toBeCalledWith('token', 'valid-token') + }) + + it('does not commit the moderator to the store', () => { + expect(storeCommitMock).not.toBeCalledWith('moderator', { isAdmin: false }) + }) + + it('redirects to /not-found', async () => { + expect(next).toBeCalledWith({ path: '/not-found' }) + }) + }) + describe('without valid token', () => { it('does not commit the token to the store', async () => { navGuard({ path: '/authenticate' }, {}, next) @@ -55,9 +118,16 @@ describe('navigation guards', () => { expect(next).toBeCalledWith({ path: '/not-found' }) }) - it('does not redirect when token in store', () => { + it('redirects to not found with token in store and not moderator', () => { store.state.token = 'valid token' navGuard({ path: '/' }, {}, next) + expect(next).toBeCalledWith({ path: '/not-found' }) + }) + + it('does not redirect with token in store and as moderator', () => { + store.state.token = 'valid token' + store.state.moderator = { isAdmin: true } + navGuard({ path: '/' }, {}, next) expect(next).toBeCalledWith() }) }) diff --git a/admin/src/store/store.js b/admin/src/store/store.js index d67537499..fe5629e19 100644 --- a/admin/src/store/store.js +++ b/admin/src/store/store.js @@ -18,6 +18,9 @@ export const mutations = { token: (state, token) => { state.token = token }, + setOpenCreations: (state, openCreations) => { + state.openCreations = openCreations + }, moderator: (state, moderator) => { state.moderator = moderator }, @@ -26,6 +29,7 @@ export const mutations = { export const actions = { logout: ({ commit, state }) => { commit('token', null) + commit('moderator', null) window.localStorage.clear() }, } @@ -38,7 +42,7 @@ const store = new Vuex.Store({ ], state: { token: CONFIG.DEBUG_DISABLE_AUTH ? 'validToken' : null, - moderator: { name: 'Dertest Moderator', id: 0 }, + moderator: null, openCreations: 0, }, // Syncronous mutation of the state diff --git a/admin/src/store/store.test.js b/admin/src/store/store.test.js index 4482a46bf..e027ebf1a 100644 --- a/admin/src/store/store.test.js +++ b/admin/src/store/store.test.js @@ -1,11 +1,19 @@ import store, { mutations, actions } from './store' +import CONFIG from '../config' -const { token, openCreationsPlus, openCreationsMinus, resetOpenCreations } = mutations +jest.mock('../config') + +const { + token, + openCreationsPlus, + openCreationsMinus, + resetOpenCreations, + setOpenCreations, + moderator, +} = mutations const { logout } = actions -const CONFIG = { - DEBUG_DISABLE_AUTH: true, -} +CONFIG.DEBUG_DISABLE_AUTH = true describe('Vuex store', () => { describe('mutations', () => { @@ -40,6 +48,22 @@ describe('Vuex store', () => { expect(state.openCreations).toEqual(0) }) }) + + describe('moderator', () => { + it('sets the moderator object in state', () => { + const state = { moderator: null } + moderator(state, { id: 1 }) + expect(state.moderator).toEqual({ id: 1 }) + }) + }) + + describe('setOpenCreations', () => { + it('sets the open creations to given value', () => { + const state = { openCreations: 24 } + setOpenCreations(state, 12) + expect(state.openCreations).toEqual(12) + }) + }) }) describe('actions', () => { @@ -57,6 +81,11 @@ describe('Vuex store', () => { expect(commit).toBeCalledWith('token', null) }) + it('deletes the moderator in store', () => { + logout({ commit, state }) + expect(commit).toBeCalledWith('moderator', null) + }) + it.skip('clears the window local storage', () => { expect(windowStorageMock).toBeCalled() }) diff --git a/backend/src/graphql/model/PendingCreation.ts b/backend/src/graphql/model/PendingCreation.ts new file mode 100644 index 000000000..f1087ea0b --- /dev/null +++ b/backend/src/graphql/model/PendingCreation.ts @@ -0,0 +1,34 @@ +import { ObjectType, Field, Int } from 'type-graphql' + +@ObjectType() +export class PendingCreation { + @Field(() => String) + firstName: string + + @Field(() => Int) + id?: number + + @Field(() => String) + lastName: string + + @Field(() => Number) + userId: number + + @Field(() => String) + email: string + + @Field(() => Date) + date: Date + + @Field(() => String) + memo: string + + @Field(() => Number) + amount: BigInt + + @Field(() => Number) + moderator: number + + @Field(() => [Number]) + creation: number[] +} diff --git a/backend/src/graphql/resolver/AdminResolver.ts b/backend/src/graphql/resolver/AdminResolver.ts index f3c9d1516..169b79250 100644 --- a/backend/src/graphql/resolver/AdminResolver.ts +++ b/backend/src/graphql/resolver/AdminResolver.ts @@ -1,7 +1,7 @@ import { Resolver, Query, Arg, Args, Authorized, Mutation } from 'type-graphql' import { getCustomRepository, Raw } from 'typeorm' import { UserAdmin } from '../model/UserAdmin' -import { LoginUserRepository } from '../../typeorm/repository/LoginUser' +import { PendingCreation } from '../model/PendingCreation' import { RIGHTS } from '../../auth/RIGHTS' import { TransactionCreationRepository } from '../../typeorm/repository/TransactionCreation' import { PendingCreationRepository } from '../../typeorm/repository/PendingCreation' @@ -14,19 +14,19 @@ export class AdminResolver { @Authorized([RIGHTS.SEARCH_USERS]) @Query(() => [UserAdmin]) async searchUsers(@Arg('searchText') searchText: string): Promise { - const loginUserRepository = getCustomRepository(LoginUserRepository) - const loginUsers = await loginUserRepository.findBySearchCriteria(searchText) - const users = await Promise.all( - loginUsers.map(async (loginUser) => { - const user = new UserAdmin() - user.firstName = loginUser.firstName - user.lastName = loginUser.lastName - user.email = loginUser.email - user.creation = await getUserCreations(loginUser.id) - return user + const userRepository = getCustomRepository(UserRepository) + const users = await userRepository.findBySearchCriteria(searchText) + const adminUsers = await Promise.all( + users.map(async (user) => { + const adminUser = new UserAdmin() + adminUser.firstName = user.firstName + adminUser.lastName = user.lastName + adminUser.email = user.email + adminUser.creation = await getUserCreations(user.id) + return adminUser }), ) - return users + return adminUsers } @Mutation(() => [Number]) @@ -52,6 +52,30 @@ export class AdminResolver { } return await getUserCreations(user.id) } + + @Query(() => [PendingCreation]) + async getPendingCreations(): Promise { + const pendingCreationRepository = getCustomRepository(PendingCreationRepository) + const pendingCreations = await pendingCreationRepository.find() + + const pendingCreationsPromise = await Promise.all( + pendingCreations.map(async (pendingCreation) => { + const userRepository = getCustomRepository(UserRepository) + const user = await userRepository.findOneOrFail({ id: pendingCreation.userId }) + + const newPendingCreation = { + ...pendingCreation, + firstName: user.firstName, + lastName: user.lastName, + email: user.email, + creation: await getUserCreations(user.id), + } + + return newPendingCreation + }), + ) + return pendingCreationsPromise + } } async function getUserCreations(id: number): Promise { diff --git a/backend/src/typeorm/repository/User.ts b/backend/src/typeorm/repository/User.ts index e127c179c..cf67c837b 100644 --- a/backend/src/typeorm/repository/User.ts +++ b/backend/src/typeorm/repository/User.ts @@ -30,4 +30,17 @@ export class UserRepository extends Repository { }) return usersIndiced } + + async findBySearchCriteria(searchCriteria: string): Promise { + return await this.createQueryBuilder('user') + .where( + 'user.firstName like :name or user.lastName like :lastName or user.email like :email', + { + name: `%${searchCriteria}%`, + lastName: `%${searchCriteria}%`, + email: `%${searchCriteria}%`, + }, + ) + .getMany() + } } diff --git a/backend/src/webhook/elopage.ts b/backend/src/webhook/elopage.ts index 9e2ddeb81..eb46b10e8 100644 --- a/backend/src/webhook/elopage.ts +++ b/backend/src/webhook/elopage.ts @@ -1,3 +1,5 @@ +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/explicit-module-boundary-types */ /* Elopage Webhook diff --git a/scripts/release.sh b/scripts/release.sh index d18c4948c..0b70e76ad 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -6,6 +6,7 @@ PROJECT_DIR="${SCRIPT_DIR}/../" FRONTEND_DIR="${PROJECT_DIR}/frontend/" BACKEND_DIR="${PROJECT_DIR}/backend/" DATABASE_DIR="${PROJECT_DIR}/database/" +ADMIN_DIR="${PROJECT_DIR}/admin/" # navigate to project directory cd ${PROJECT_DIR} @@ -23,6 +24,8 @@ cd ${BACKEND_DIR} yarn version --no-git-tag-version --no-commit-hooks --no-commit --new-version ${VERSION} cd ${DATABASE_DIR} yarn version --no-git-tag-version --no-commit-hooks --no-commit --new-version ${VERSION} +cd ${ADMIN_DIR} +yarn version --no-git-tag-version --no-commit-hooks --no-commit --new-version ${VERSION} # generate changelog cd ${PROJECT_DIR}