Merge branch 'develop' of Software_Engineering_I/greenvironment-server into master

CHANGELOG.md

@@ -36,6 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - delete handler for media to delete the corresponding file
 - type for create post to know if it is a media or text post (media posts are invisible until a media file is uploaded)
 - reports and mutations to report posts and create reasons to report
+- level entity
 
 ### Removed
 
@@ -51,6 +52,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - config behaviour to use all files that reside in the ./config directory with the .toml format
 - default response timeout from 2 minutes to 30 seconds
 - cluster api to start workers with a 2 second delay each to avoid race conditions
+- levels to be configured in the backend
 
 ### Fixed
 
@@ -60,7 +62,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - style issues
 - graphql schema for denyRequest using the wrong parameters
 - sendRequest allowing duplicates
-
+- upload throwing an error when the old picture doesn't exist
+- extension of uploaded videos doesn't have a dot
 
 ## [0.9] - 2019-10-29
 

src/lib/UploadManager.ts

@@ -98,7 +98,7 @@ export class UploadManager {
      * @param extension
      */
     public async processAndStoreVideo(data: Buffer, extension: string): Promise<Media> {
-        const fileBasename = UploadManager.getCrypticFileName() + extension;
+        const fileBasename = UploadManager.getCrypticFileName() + "." + extension;
         await fsx.ensureDir(this.dataDir);
         const filePath = path.join(this.dataDir, fileBasename);
         await fsx.writeFile(filePath, data);

src/lib/dataAccess.ts

@@ -67,12 +67,12 @@ namespace dataaccess {
                 models.Media,
                 models.Report,
                 models.ReportReason,
+                models.Level,
             ]);
         } catch (err) {
             globals.logger.error(err.message);
             globals.logger.debug(err.stack);
         }
-        await databaseCleanup();
         setInterval(databaseCleanup, config.get<number>("database.cleanupInterval") * 1000);
     }
 

src/lib/errors/LevelAlreadyExistsError.ts

@@ -0,0 +1,10 @@
+import {BaseError} from "./BaseError";
+
+/**
+ * An error that is thrown when the level already exists
+ */
+export class LevelAlreadyExistsError extends BaseError {
+    constructor(property: string) {
+        super(`A level with the property value '${property}' already exists`);
+    }
+}

src/lib/models/Level.ts

@@ -0,0 +1,32 @@
+import * as sqz from "sequelize";
+import {Column, Model, NotNull, Table, Unique} from "sequelize-typescript";
+
+/**
+ * A level of the ranking system
+ */
+@Table({underscored: true})
+export class Level extends Model<Level> {
+
+    /**
+     * The name of the level
+     */
+    @NotNull
+    @Unique
+    @Column({allowNull: false, type: sqz.STRING(64), unique: true})
+    public name: string;
+
+    /**
+     * The required points for the level
+     */
+    @NotNull
+    @Unique
+    @Column({allowNull: false, unique: true})
+    public points: number;
+
+    /**
+     * Returns the number of the level as the number of the database entry
+     */
+    public async levelNumber(): Promise<number> {
+        return Level.count({where: {points: {[sqz.Op.lte]: this.points}}});
+    }
+}

src/lib/models/Media.ts

@@ -18,8 +18,10 @@ export class Media extends Model<Media> {
      */
     @BeforeDestroy
     public static async deleteMediaFile(instance: Media) {
+        if (await fsx.pathExists(instance.path)) {
             await fsx.unlink(instance.path);
         }
+    }
 
     /**
      * The api url for the media

src/lib/models/User.ts

@@ -1,5 +1,6 @@
 import * as sqz from "sequelize";
 import {
+    BeforeUpdate,
     BelongsTo,
     BelongsToMany,
     Column,
@@ -24,6 +25,7 @@ import {Friendship} from "./Friendship";
 import {Group} from "./Group";
 import {GroupAdmin} from "./GroupAdmin";
 import {GroupMember} from "./GroupMember";
+import {Level} from "./Level";
 import {Media} from "./Media";
 import {Post} from "./Post";
 import {PostVote} from "./PostVote";
@@ -35,6 +37,19 @@ import {Request, RequestType} from "./Request";
 @Table({underscored: true})
 export class User extends Model<User> {
 
+    /**
+     * A function that is called before the user is updated.
+     * It assigns the corresponding level to the user
+     * @param instance
+     */
+    @BeforeUpdate
+    public static async assignLevel(instance: User) {
+        const level = await Level.findOne({where: {points: {[sqz.Op.lte]: instance.rankpoints}}, order: [["points", "desc"]]}) as Level;
+        if (level) {
+            instance.$set("rLevel", level);
+        }
+    }
+
     /**
      * The name of the user
      */
@@ -99,13 +114,25 @@ export class User extends Model<User> {
     @Column({defaultValue: false, allowNull: false})
     public isAdmin: boolean;
 
+    /**
+     * The level of the user
+     */
+    @ForeignKey(() => Level)
+    @Column({allowNull: true})
+    public levelId: number;
+
     /**
      * The id of the media that is the users profile picture
      */
     @ForeignKey(() => Media)
-    @Column({allowNull: false})
+    @Column({allowNull: true})
     public mediaId: number;
 
+    /**
+     * The level of the user
+     */
+    @BelongsTo(() => Level)
+    public rLevel: Level;
 
     /**
      * The media of the user
@@ -221,8 +248,8 @@ export class User extends Model<User> {
     /**
      * The level of the user which is the points divided by 100
      */
-    public get level(): number {
-        return Math.ceil(this.getDataValue("rankpoints") / 100);
+    public async level(): Promise<Level> {
+        return await this.$get("rLevel") as Level;
     }
 
     /**

src/lib/models/index.ts

@@ -16,3 +16,4 @@ export {BlacklistedPhrase} from "./BlacklistedPhrase";
 export {Media} from "./Media";
 export {Report} from "./Report";
 export {ReportReason} from "./ReportReason";
+export {Level} from "./Level";

src/routes/graphql/MutationResolver.ts

@@ -1,11 +1,13 @@
 import {GraphQLError} from "graphql";
 import * as yaml from "js-yaml";
+import sequelize from "sequelize";
 import isEmail from "validator/lib/isEmail";
 import dataAccess from "../../lib/dataAccess";
 import {BlacklistedError} from "../../lib/errors/BlacklistedError";
 import {GroupNotFoundError} from "../../lib/errors/GroupNotFoundError";
 import {HandleInUseError} from "../../lib/errors/HandleInUseError";
 import {InvalidEmailError} from "../../lib/errors/InvalidEmailError";
+import {LevelAlreadyExistsError} from "../../lib/errors/LevelAlreadyExistsError";
 import {NotAGroupAdminError} from "../../lib/errors/NotAGroupAdminError";
 import {NotAnAdminError} from "../../lib/errors/NotAnAdminError";
 import {NotTheGroupCreatorError} from "../../lib/errors/NotTheGroupCreatorError";
@@ -15,7 +17,18 @@ import {ReportReasonNameAlreadyExistsError} from "../../lib/errors/ReportReasonN
 import {ReportReasonNotFoundError} from "../../lib/errors/ReportReasonNotFoundError";
 import globals from "../../lib/globals";
 import {InternalEvents} from "../../lib/InternalEvents";
-import {Activity, BlacklistedPhrase, ChatMessage, ChatRoom, Event, Group, Post, Request, User} from "../../lib/models";
+import {
+    Activity,
+    BlacklistedPhrase,
+    ChatMessage,
+    ChatRoom,
+    Event,
+    Group,
+    Level,
+    Post,
+    Request,
+    User,
+} from "../../lib/models";
 import {Report} from "../../lib/models";
 import {ReportReason} from "../../lib/models";
 import {UploadManager} from "../../lib/UploadManager";
@@ -147,6 +160,8 @@ export class MutationResolver extends BaseResolver {
             await user.save();
             return user.settings;
         } catch (err) {
+            globals.logger.warning(err.message);
+            globals.logger.debug(err.stack);
             throw new GraphQLError("Invalid settings json.");
         }
     }
@@ -557,4 +572,26 @@ export class MutationResolver extends BaseResolver {
         }
         return ReportReason.create({name, description});
     }
+
+    /**
+     * Creates a new level
+     * @param name
+     * @param levelNumber
+     * @param requiredPoints
+     * @param request
+     */
+    public async createLevel({name, requiredPoints}: {name: string, requiredPoints: number}, request: any):
+        Promise<Level> {
+        this.ensureLoggedIn(request);
+        const user = await User.findByPk(request.session.userId);
+        if (!user.isAdmin) {
+            throw new NotAnAdminError();
+        }
+        const existingLevel = await Level.findOne({where: {[sequelize.Op.or]: [{name}, {points: requiredPoints}]}});
+        if (existingLevel) {
+            throw new LevelAlreadyExistsError(
+                existingLevel.name === name ? "name" : "points");
+        }
+        return Level.create({name, points: requiredPoints});
+    }
 }

src/routes/graphql/QueryResolver.ts

@@ -7,7 +7,18 @@ import {GroupNotFoundError} from "../../lib/errors/GroupNotFoundError";
 import {NotAnAdminError} from "../../lib/errors/NotAnAdminError";
 import {RequestNotFoundError} from "../../lib/errors/RequestNotFoundError";
 import {UserNotFoundError} from "../../lib/errors/UserNotFoundError";
-import {Activity, BlacklistedPhrase, ChatRoom, Event, Group, Post, Report, Request, User} from "../../lib/models";
+import {
+    Activity,
+    BlacklistedPhrase,
+    ChatRoom,
+    Event,
+    Group,
+    Level,
+    Post,
+    Report,
+    Request,
+    User
+} from "../../lib/models";
 import {BlacklistedResult} from "./BlacklistedResult";
 import {MutationResolver} from "./MutationResolver";
 import {SearchResult} from "./SearchResult";
@@ -198,6 +209,15 @@ export class QueryResolver extends MutationResolver {
         if (!user?.isAdmin) {
             throw new NotAnAdminError();
         }
-        return Report.findAll({limit: first, offset});
+        return Report.findAll({limit: first, offset, order: [["id", "DESC"]]});
+    }
+
+    /**
+     * Returns the levels that are configured
+     * @param first
+     * @param offset
+     */
+    public async getLevels({first, offset}: {first: number, offset: number}): Promise<Level[]> {
+        return Level.findAll({limit: first, offset, order: [["points", "ASC"]]});
     }
 }

src/routes/graphql/schema.graphql

@@ -48,6 +48,9 @@ type Query {
 
     "Returns all issued reports with pagination"
     getReports(first: Int = 20, offset: Int = 0): [Report!]! @complexity(value: 1, multipliers: ["first"])
+
+    "Returns the levels configured in the backend"
+    getLevels(first: Int =20, offset: Int = 0): [Level!]! @complexity(value: 1, multipliers: ["first"])
 }
 
 type Mutation {
@@ -143,6 +146,9 @@ type Mutation {
 
     "Creates a new report reason"
     createReportReason(name: String!, description: String!): ReportReason
+
+    "Creates a new level"
+    createLevel(name: String!, requiredPoints: Int!): Level!
 }
 
 interface UserData {
@@ -189,7 +195,7 @@ interface UserData {
     points: Int!
 
     "the levels of the user depending on the points"
-    level: Int!
+    level: Level
 }
 
 "represents a single user account"
@@ -240,7 +246,7 @@ type User implements UserData{
     eventCount: Int!
 
     "the levels of the user depending on the points"
-    level: Int!
+    level: Level
 }
 
 type Profile implements UserData {
@@ -311,7 +317,7 @@ type Profile implements UserData {
     points: Int!
 
     "the levels of the user depending on the points"
-    level: Int!
+    level: Level
 
     "the custom settings for the frontend"
     settings: String!
@@ -571,6 +577,22 @@ type ReportReason {
     description: String!
 }
 
+"A level of a user"
+type Level {
+
+    "The level id"
+    id: ID!
+
+    "The name of the level"
+    name: String!
+
+    "The number of the level in the ranking"
+    levelNumber: Int!
+
+    "The points required for this level"
+    points: Int!
+}
+
 "represents the type of media"
 enum MediaType {
     VIDEO