merge dev to main (#208)

Co-authored-by: Nicolai Ort <info@nicolai-ort.com>
Reviewed-on: #208
Co-authored-by: Philipp Dormann <philipp@philippdormann.de>
Co-committed-by: Philipp Dormann <philipp@philippdormann.de>

.drone.yml

@@ -163,12 +163,6 @@ steps:
         - "${DRONE_TAG}"
       cache: true
       registry: registry.odit.services
-  - name: trigger node lib build
-    image: idcooldi/drone-webhook
-    settings:
-      urls: https://ci.odit.services/api/repos/lfk/lfk-client-node/builds?SOURCE_TAG=${DRONE_TAG}
-      bearer:
-        from_secret: ci_token
   - name: trigger js lib build
     image: idcooldi/drone-webhook
     settings:

.gitignore

@@ -136,4 +136,3 @@ build
 lib
 /oss-attribution
 *.tmp
-pnpm-lock.yaml

CHANGELOG.md

@@ -2,8 +2,49 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
-#### [v1.0.0](https://git.odit.services/lfk/backend/compare/v0.15.4...v1.0.0)
+#### [v1.1.3](https://git.odit.services/lfk/backend/compare/v1.1.2...v1.1.3)
 
+- feat(orgs): Also resolve child-teams' distances and add them to org total [`8d94186`](https://git.odit.services/lfk/backend/commit/8d9418635d3e381c0f55a2521a3334ba497c169a)
+- fix(orgs): Removed unused log [`f2832a2`](https://git.odit.services/lfk/backend/commit/f2832a2daecc7bc7bbee4d4fceeab8db194730cf)
+
+#### [v1.1.2](https://git.odit.services/lfk/backend/compare/v1.1.1...v1.1.2)
+
+> 10 May 2023
+
+- 🚀Bumped version to v1.1.2 [`0d21596`](https://git.odit.services/lfk/backend/commit/0d21596e2b64a99258d4925ae2ad627d5cdbd984)
+- feat(groups): Resolve the total group distance on group get single (aka get org and get team) [`245827e`](https://git.odit.services/lfk/backend/commit/245827e9c659cf76183dc33ab253becc22ddf032)
+- chore(package): Formatting [`4608a36`](https://git.odit.services/lfk/backend/commit/4608a36df6b187520ca0c331b8dce615205257be)
+
+#### [v1.1.1](https://git.odit.services/lfk/backend/compare/v1.1.0...v1.1.1)
+
+> 19 April 2023
+
+- feat(donors): Resolve donations with donors via pagination [`12a9ae2`](https://git.odit.services/lfk/backend/commit/12a9ae24933117acb3ff9815a7d72abca5eea7a7)
+- 🚀Bumped version to v1.1.1 [`cb1305a`](https://git.odit.services/lfk/backend/commit/cb1305aa77c36aa9d7900f09e7413bc6d45f2c89)
+
+#### [v1.1.0](https://git.odit.services/lfk/backend/compare/v1.0.1...v1.1.0)
+
+> 19 April 2023
+
+- feat(stats): Added donation count and donor count to stats [`6f39ac4`](https://git.odit.services/lfk/backend/commit/6f39ac42dafc2a589bbb2256b0417f3e774ae174)
+- 🚀Bumped version to v1.1.0 [`b9fe9f1`](https://git.odit.services/lfk/backend/commit/b9fe9f1c24653b91255a6dbbdc32c30b1b411eeb)
+- Added average donation per distance to stats [`fe59e3a`](https://git.odit.services/lfk/backend/commit/fe59e3a557903cf555d4c50098e935c49ca1fac4)
+- Added hints [`b25b0db`](https://git.odit.services/lfk/backend/commit/b25b0db76071ef8d50cc60e950a399dc060a2a9f)
+- Added calls to controller [`6ee5328`](https://git.odit.services/lfk/backend/commit/6ee5328dbc404603d19db3a5173ae4def560a9c9)
+- Formatting [`42c23a5`](https://git.odit.services/lfk/backend/commit/42c23a5883dacda4e0147842d448b3ad35b197b1)
+
+#### [v1.0.1](https://git.odit.services/lfk/backend/compare/v1.0.0...v1.0.1)
+
+> 18 April 2023
+
+- fix(pagination) page=0 resulted in false thx JS [`fcee390`](https://git.odit.services/lfk/backend/commit/fcee3909f4c4664115cc7ecb94f30e0dd8e78ce0)
+- 🚀Bumped version to v1.0.1 [`301f334`](https://git.odit.services/lfk/backend/commit/301f33467489a8533bdac11fbd10efd1b791f5e3)
+
+### [v1.0.0](https://git.odit.services/lfk/backend/compare/v0.15.4...v1.0.0)
+
+> 18 April 2023
+
+- 🚀Bumped version to v1.0.0 [`f0e20e4`](https://git.odit.services/lfk/backend/commit/f0e20e413014fe446c97754d2765cdad92c2cc3b)
 - Merge pull request 'feature/205-pagination' (#206) from feature/205-pagination into dev [`80de188`](https://git.odit.services/lfk/backend/commit/80de188565523d642407612272432ef07672b890)
 - Added pagination for runner orgs [`538622a`](https://git.odit.services/lfk/backend/commit/538622aa1841e27256f304e15b4204c2f6d24d76)
 - RunnerTeam Pagination [`0fa663a`](https://git.odit.services/lfk/backend/commit/0fa663a34104d438dd8fc9ab02458fdf289329f8)

Dockerfile

@@ -1,5 +1,5 @@
 # Typescript Build
-FROM registry.odit.services/hub/library/node:19.5.0-alpine3.16 as build
+FROM registry.odit.services/hub/library/node:21.1.0-alpine3.18 as build
 ARG NPM_REGISTRY_URL=https://registry.npmjs.org
 WORKDIR /app
 
@@ -14,7 +14,7 @@ RUN pnpm run build \
     && pnpm i --production --prefer-offline
 
 # final image
-FROM registry.odit.services/hub/library/node:19.5.0-alpine3.16 as final
+FROM registry.odit.services/hub/library/node:21.1.0-alpine3.18 as final
 WORKDIR /app
 COPY --from=build /app/package.json /app/package.json
 COPY --from=build /app/ormconfig.js /app/ormconfig.js

README.md

@@ -15,24 +15,24 @@ Backend Server
 
 1. Rename the .env.example file to .env (you can adjust app port and other settings, if needed)
 2. Install Dependencies
-   ```bash
-   yarn
-   ```
+```bash
+pnpm i
+```
 3. Start the server
-   ```bash
-   yarn dev
-   ```
+```bash
+pnpm dev
+```
 
 ### Run Tests
 ```bash
 # Run tests once (server has to run)
-yarn test
+pnpm test
 
 # Run test in watch mode (reruns on change)
-yarn test:watch
+pnpm test:watch
 
 # Run test in ci mode (automaticly starts the dev server)
-yarn test:ci
+pnpm test:ci
 ```
 
 ### Use your own mail templates
@@ -44,7 +44,7 @@ Currently the following templates exist:
 
 ### Generate Docs
 ```bash
-yarn docs
+pnpm docs
 ```
 
 ## ENV Vars
@@ -90,5 +90,5 @@ yarn docs
    * The dev tag of the docker image get's build from this
    * Only push minor changes to this branch!
    * To merge a feature branch into this please create a pull request
-* feature/xyz: Feature branches - nameing scheme: `feature/issueid-title`
-* bugfix/xyz: Branches for bugfixes - nameing scheme:`bugfix/issueid-title`
+* feature/xyz: Feature branches - naming scheme: `feature/issueid-title`
+* bugfix/xyz: Branches for bugfixes - naming scheme:`bugfix/issueid-title`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odit/lfk-backend",
-  "version": "1.0.0",
+  "version": "1.1.3",
   "main": "src/app.ts",
   "repository": "https://git.odit.services/lfk/backend",
   "engines": {
@@ -54,7 +54,7 @@
     "validator": "13.5.2"
   },
   "devDependencies": {
-    "@faker-js/faker": "^7.6.0",
+    "@faker-js/faker": "7.6.0",
     "@odit/license-exporter": "0.0.9",
     "@types/cors": "2.8.9",
     "@types/csvtojson": "1.1.5",
@@ -63,7 +63,7 @@
     "@types/jsonwebtoken": "8.5.0",
     "@types/node": "14.14.22",
     "@types/uuid": "8.3.0",
-    "auto-changelog": "^2.4.0",
+    "auto-changelog": "2.4.0",
     "cp-cli": "2.0.0",
     "jest": "26.6.3",
     "nodemon": "2.0.7",
@@ -114,4 +114,4 @@
       "docs/*"
     ]
   }
-}
+}

src/controllers/DonationController.ts

@@ -40,7 +40,7 @@ export class DonationController {
 		let responseDonations: ResponseDonation[] = new Array<ResponseDonation>();
 		let donations: Array<Donation>;
 
-		if (page) {
+		if (page != undefined) {
 			donations = await this.donationRepository.find({ relations: ['runner', 'donor', 'runner.scans', 'runner.scans.track'], skip: page * page_size, take: page_size });
 		} else {
 			donations = await this.donationRepository.find({ relations: ['runner', 'donor', 'runner.scans', 'runner.scans.track'] });

src/controllers/DonorController.ts

@@ -29,7 +29,7 @@ export class DonorController {
 		let responseDonors: ResponseDonor[] = new Array<ResponseDonor>();
 		let donors: Array<Donor>;
 
-		if (page) {
+		if (page != undefined) {
 			donors = await this.donorRepository.find({ relations: ['donations', 'donations.runner', 'donations.runner.scans', 'donations.runner.scans.track'], skip: page * page_size, take: page_size });
 		} else {
 			donors = await this.donorRepository.find({ relations: ['donations', 'donations.runner', 'donations.runner.scans', 'donations.runner.scans.track'] });

src/controllers/GroupContactController.ts

@@ -30,7 +30,7 @@ export class GroupContactController {
 		let responseContacts: ResponseGroupContact[] = new Array<ResponseGroupContact>();
 		let contacts: Array<GroupContact>;
 
-		if (page) {
+		if (page != undefined) {
 			contacts = await this.contactRepository.find({ relations: ['groups', 'groups.parentGroup'], skip: page * page_size, take: page_size });
 		} else {
 			contacts = await this.contactRepository.find({ relations: ['groups', 'groups.parentGroup'] });

src/controllers/PermissionController.ts

@@ -31,7 +31,7 @@ export class PermissionController {
         let responsePermissions: ResponsePermission[] = new Array<ResponsePermission>();
         let permissions: Array<Permission>;
 
-        if (page) {
+        if (page != undefined) {
             permissions = await this.permissionRepository.find({ relations: ['principal'], skip: page * page_size, take: page_size });
         } else {
             permissions = await this.permissionRepository.find({ relations: ['principal'] });

src/controllers/RunnerCardController.ts

@@ -30,7 +30,7 @@ export class RunnerCardController {
 		let responseCards: ResponseRunnerCard[] = new Array<ResponseRunnerCard>();
 		let cards: Array<RunnerCard>;
 
-		if (page) {
+		if (page != undefined) {
 			cards = await this.cardRepository.find({ relations: ['runner', 'runner.group', 'runner.group.parentGroup'], skip: page * page_size, take: page_size });
 		} else {
 			cards = await this.cardRepository.find({ relations: ['runner', 'runner.group', 'runner.group.parentGroup'] });

src/controllers/RunnerController.ts

@@ -34,7 +34,7 @@ export class RunnerController {
 		let responseRunners: ResponseRunner[] = new Array<ResponseRunner>();
 		let runners: Array<Runner>;
 
-		if (page) {
+		if (page != undefined) {
 			runners = await this.runnerRepository.find({ relations: ['scans', 'group', 'group.parentGroup', 'scans.track'], skip: page * page_size, take: page_size });
 		} else {
 			runners = await this.runnerRepository.find({ relations: ['scans', 'group', 'group.parentGroup', 'scans.track'] });

src/controllers/RunnerOrganizationController.ts

@@ -33,7 +33,7 @@ export class RunnerOrganizationController {
 		let responseOrgs: ResponseRunnerOrganization[] = new Array<ResponseRunnerOrganization>();
 		let orgs: Array<RunnerOrganization>;
 
-		if (page) {
+		if (page != undefined) {
 			orgs = await this.runnerOrganizationRepository.find({ relations: ['contact', 'teams'], skip: page * page_size, take: page_size });
 		} else {
 			orgs = await this.runnerOrganizationRepository.find({ relations: ['contact', 'teams'] });
@@ -52,7 +52,7 @@ export class RunnerOrganizationController {
 	@OnUndefined(RunnerOrganizationNotFoundError)
 	@OpenAPI({ description: 'Lists all information about the organization whose id got provided.' })
 	async getOne(@Param('id') id: number) {
-		let runnerOrg = await this.runnerOrganizationRepository.findOne({ id: id }, { relations: ['contact', 'teams'] });
+		let runnerOrg = await this.runnerOrganizationRepository.findOne({ id: id }, { relations: ['contact', 'teams', 'teams.runners', 'teams.runners.scans', 'teams.runners.scans.track', 'runners', 'runners.scans', 'runners.scans.track'] });
 		if (!runnerOrg) { throw new RunnerOrganizationNotFoundError(); }
 		return new ResponseRunnerOrganization(runnerOrg);
 	}

src/controllers/RunnerTeamController.ts

@@ -31,7 +31,7 @@ export class RunnerTeamController {
 		let responseTeams: ResponseRunnerTeam[] = new Array<ResponseRunnerTeam>();
 		let teams: Array<RunnerTeam>;
 
-		if (page) {
+		if (page != undefined) {
 			teams = await this.runnerTeamRepository.find({ relations: ['parentGroup', 'contact'], skip: page * page_size, take: page_size });
 		} else {
 			teams = await this.runnerTeamRepository.find({ relations: ['parentGroup', 'contact'] });
@@ -50,7 +50,7 @@ export class RunnerTeamController {
 	@OnUndefined(RunnerTeamNotFoundError)
 	@OpenAPI({ description: 'Lists all information about the team whose id got provided.' })
 	async getOne(@Param('id') id: number) {
-		let runnerTeam = await this.runnerTeamRepository.findOne({ id: id }, { relations: ['parentGroup', 'contact'] });
+		let runnerTeam = await this.runnerTeamRepository.findOne({ id: id }, { relations: ['parentGroup', 'contact', 'runners', 'runners.scans', 'runners.scans.track'] });
 		if (!runnerTeam) { throw new RunnerTeamNotFoundError(); }
 		return new ResponseRunnerTeam(runnerTeam);
 	}

src/controllers/ScanController.ts

@@ -38,7 +38,7 @@ export class ScanController {
 		let responseScans: ResponseScan[] = new Array<ResponseScan>();
 		let scans: Array<Scan>;
 
-		if (page) {
+		if (page != undefined) {
 			scans = await this.scanRepository.find({ relations: ['runner', 'track'], skip: page * page_size, take: page_size });
 		} else {
 			scans = await this.scanRepository.find({ relations: ['runner', 'track'] });

src/controllers/ScanStationController.ts

@@ -30,7 +30,7 @@ export class ScanStationController {
 		let responseStations: ResponseScanStation[] = new Array<ResponseScanStation>();
 		let stations: Array<ScanStation>;
 
-		if (page) {
+		if (page != undefined) {
 			stations = await this.stationRepository.find({ relations: ['track'], skip: page * page_size, take: page_size });
 		} else {
 			stations = await this.stationRepository.find({ relations: ['track'] });

src/controllers/StatsClientController.ts

@@ -28,7 +28,7 @@ export class StatsClientController {
 		let responseClients: ResponseStatsClient[] = new Array<ResponseStatsClient>();
 		let clients: Array<StatsClient>;
 
-		if (page) {
+		if (page != undefined) {
 			clients = await this.clientRepository.find({ skip: page * page_size, take: page_size });
 		} else {
 			clients = await this.clientRepository.find();

src/controllers/StatsController.ts

@@ -3,6 +3,7 @@ import { OpenAPI, ResponseSchema } from 'routing-controllers-openapi';
 import { getConnection } from 'typeorm';
 import StatsAuth from '../middlewares/StatsAuth';
 import { Donation } from '../models/entities/Donation';
+import { Donor } from '../models/entities/Donor';
 import { Runner } from '../models/entities/Runner';
 import { RunnerOrganization } from '../models/entities/RunnerOrganization';
 import { RunnerTeam } from '../models/entities/RunnerTeam';
@@ -27,6 +28,7 @@ export class StatsController {
         const orgs = await connection.getRepository(RunnerOrganization).count();
         const users = await connection.getRepository(User).count();
         const scans = await connection.getRepository(Scan).count({ where: { valid: true } });
+
         const distance_query = await connection.getRepository(Scan).createQueryBuilder('scan')
             .leftJoinAndSelect("scan.track", "track").where("scan.valid = TRUE")
             .select("SUM(track.distance)", "sum_track").addSelect("SUM(_distance)", "sum_distance")
@@ -35,8 +37,11 @@ export class StatsController {
         if (distance_query.sum_distance) {
             distace += parseInt(distance_query.sum_distance)
         }
+
         let donations = await connection.getRepository(Donation).find({ relations: ['runner', 'runner.scans', 'runner.scans.track'] });
-        return new ResponseStats(runners, teams, orgs, users, scans, donations, distace)
+        const donors = await connection.getRepository(Donor).count();
+
+        return new ResponseStats(runners, teams, orgs, users, scans, donations, distace, donors)
     }
 
     @Get("/runners/distance")

src/controllers/TrackController.ts

@@ -29,7 +29,7 @@ export class TrackController {
 		let responseTracks: ResponseTrack[] = new Array<ResponseTrack>();
 		let tracks: Array<Track>;
 
-		if (page) {
+		if (page != undefined) {
 			tracks = await this.trackRepository.find({ skip: page * page_size, take: page_size });
 		}
 		else {

src/controllers/UserController.ts

@@ -32,7 +32,7 @@ export class UserController {
 		let responseUsers: ResponseUser[] = new Array<ResponseUser>();
 		let users: Array<User>;
 
-		if (page) {
+		if (page != undefined) {
 			users = await this.userRepository.find({ relations: ['permissions', 'groups', 'groups.permissions'], skip: page * page_size, take: page_size });
 		}
 		else {

src/controllers/UserGroupController.ts

@@ -31,7 +31,7 @@ export class UserGroupController {
 		let responseGroups: ResponseUserGroup[] = new Array<ResponseUserGroup>();
 		let groups: Array<UserGroup>;
 
-		if (page) {
+		if (page != undefined) {
 			groups = await this.userGroupsRepository.find({ relations: ['permissions'], skip: page * page_size, take: page_size });
 		} else {
 			groups = await this.userGroupsRepository.find({ relations: ['permissions'] });

src/models/responses/ResponseDonation.ts

@@ -53,7 +53,9 @@ export class ResponseDonation implements IResponse {
      */
     public constructor(donation: Donation) {
         this.id = donation.id;
-        this.donor = donation.donor.toResponse();
+        if (donation.donor) {
+            this.donor = donation.donor.toResponse();
+        }
         this.amount = donation.amount;
         this.paidAmount = donation.paidAmount || 0;
         if (this.paidAmount < this.amount) {

src/models/responses/ResponseDonor.ts

@@ -4,6 +4,7 @@ import {
 import { Donor } from '../entities/Donor';
 import { ResponseObjectType } from '../enums/ResponseObjectType';
 import { IResponse } from './IResponse';
+import { ResponseDonation } from './ResponseDonation';
 import { ResponseParticipant } from './ResponseParticipant';
 
 /**
@@ -34,6 +35,8 @@ export class ResponseDonor extends ResponseParticipant implements IResponse {
     @IsInt()
     paidDonationAmount: number;
 
+    donations: Array<ResponseDonation>;
+
     /**
      * Creates a ResponseRunner object from a runner.
      * @param runner The user the response shall be build for.
@@ -43,5 +46,11 @@ export class ResponseDonor extends ResponseParticipant implements IResponse {
         this.receiptNeeded = donor.receiptNeeded;
         this.donationAmount = donor.donationAmount;
         this.paidDonationAmount = donor.paidDonationAmount;
+        this.donations = new Array<ResponseDonation>();
+        if (donor.donations?.length > 0) {
+            for (const donation of donor.donations) {
+                this.donations.push(donation.toResponse())
+            }
+        }
     }
 }

src/models/responses/ResponseRunnerGroup.ts

@@ -1,4 +1,4 @@
-import { IsInt, IsNotEmpty, IsObject, IsOptional, IsString } from "class-validator";
+import { IsInt, IsNotEmpty, IsNumber, IsObject, IsOptional, IsString } from "class-validator";
 import { RunnerGroup } from '../entities/RunnerGroup';
 import { ResponseObjectType } from '../enums/ResponseObjectType';
 import { IResponse } from './IResponse';
@@ -36,6 +36,10 @@ export abstract class ResponseRunnerGroup implements IResponse {
     @IsOptional()
     contact?: ResponseGroupContact;
 
+    @IsOptional()
+    @IsNumber()
+    total_distance: number
+
     /**
      * Creates a ResponseRunnerGroup object from a runnerGroup.
      * @param group The runnerGroup the response shall be build for.
@@ -44,5 +48,6 @@ export abstract class ResponseRunnerGroup implements IResponse {
         this.id = group.id;
         this.name = group.name;
         if (group.contact) { this.contact = group.contact.toResponse(); };
+        if (group.runners) { this.total_distance = group.runners.reduce((p, c) => p + c.distance, 0) }
     }
 }

src/models/responses/ResponseRunnerOrganization.ts

@@ -67,6 +67,9 @@ export class ResponseRunnerOrganization extends ResponseRunnerGroup implements I
             for (let team of org.teams) {
                 this.teams.push(team.toResponse());
             }
+            for (const team of this.teams) {
+                this.total_distance += team.total_distance;
+            }
         }
 
         if (!org.key) { this.registrationEnabled = false; }

src/models/responses/ResponseStats.ts

@@ -58,12 +58,30 @@ export class ResponseStats implements IResponse {
     @IsInt()
     total_donation: number;
 
+    /**
+     * The total donation count (cent).
+     */
+    @IsInt()
+    total_donations: number;
+
+    /**
+     * The total donor count.
+     */
+    @IsInt()
+    total_donors: number;
+
     /**
      * The average distance ran per runner.
      */
     @IsInt()
     average_distance: number;
 
+    /**
+     * The average donation per distance (cent).
+     */
+    @IsInt()
+    average_donation: number;
+
     /**
      * Creates a new stats response containing some basic statistics for a dashboard or public display.
      * @param runners Array containing all runners - the following relations have to be resolved: scans, scans.track
@@ -73,7 +91,7 @@ export class ResponseStats implements IResponse {
      * @param scans Array containing all scans - no relations have to be resolved.
      * @param donations Array containing all donations - the following relations have to be resolved: runner, runner.scans, runner.scans.track
      */
-    public constructor(runners: number, teams: number, orgs: number, users: number, scans: number, donations: Donation[], distance: number) {
+    public constructor(runners: number, teams: number, orgs: number, users: number, scans: number, donations: Donation[], distance: number, donors: number) {
         this.total_runners = runners;
         this.total_teams = teams;
         this.total_orgs = orgs;
@@ -81,6 +99,9 @@ export class ResponseStats implements IResponse {
         this.total_scans = scans;
         this.total_distance = distance;
         this.total_donation = donations.reduce((sum, current) => sum + current.amount, 0);
+        this.total_donations = donations.length;
+        this.average_donation = this.total_donation / this.total_donations
+        this.total_donors = donors;
         this.average_distance = this.total_distance / this.total_runners;
     }
 }

src/seeds/SeedUsers.ts

@@ -11,7 +11,7 @@ import { PermissionAction } from '../models/enums/PermissionAction';
 import { PermissionTarget } from '../models/enums/PermissionTargets';
 /**
  * Seeds a admin group with a demo user into the database for initial setup and auto recovery.
- * We know that the nameing isn't perfectly fitting. Feel free to change it.
+ * We know that the naming isn't perfectly fitting. Feel free to change it.
  */
 export default class SeedUsers implements Seeder {
     public async run(factory: Factory, connection: Connection): Promise<any> {