Add magazines to weekly debrief (#66)

* Implemented community board models

- implemented Flyer and Organization models for community board feature
- modified User model
- updated typescript version to 4.0.5 to resolve es lint issue

* Implemented weekly debrief magazines

- added magazines to weekly debrief feature
- updated user and weekly debrief models to allow tracking of read magazines
- updated logic in user and weekly debrief controllers to enable reading of magazines

* Revert package.json changes

- reverted package.json changes back to the original file
- added additional rules to eslintrc to suppress es lint warnings

* Create jest testing for magazines

- added jest test cases for magazines

* Implement jest testing for User

- implemented unit testing for UserRepo
- indirectly test Weekly Debrief with User unit tests

* Update gitignore

- updated gitignore file to include secrets folder

.eslintrc.js

@@ -9,6 +9,8 @@ module.exports = {
     '@typescript-eslint/explicit-module-boundary-types': 0,
     '@typescript-eslint/no-unused-vars': 0,
     'semi-style': ['error', 'last'],
+    'import/named': 0,
+    'import/prefer-default-export': 0,
   },
   // This gets rid of weird react error for non-react project
   settings: {

.gitignore

@@ -7,6 +7,7 @@ nohup.out
 *src/certificates*
 Makefile
 start.sh
+*secrets*
 
 # ignore database dumps
 dump/

src/entities/User.ts

@@ -6,6 +6,7 @@ import WeeklyDebrief from './WeeklyDebrief';
 import { PublicationSlug } from '../common/types';
 import { Flyer } from './Flyer';
 import { Organization } from './Organization';
+import { Magazine } from './Magazine';
 
 @ObjectType({ description: 'The User Model' })
 export class User {
@@ -42,6 +43,10 @@ export class User {
   @Property({ required: true, type: () => Article, default: [] })
   readArticles: mongoose.Types.DocumentArray<DocumentType<Article>>;
 
+  @Field((type) => [Magazine])
+  @Property({ required: true, type: () => Magazine, default: [] })
+  readMagazines: mongoose.Types.DocumentArray<DocumentType<Magazine>>;
+
   @Field((type) => [Flyer])
   @Property({ required: true, type: () => Flyer, default: [] })
   readFlyers: mongoose.Types.DocumentArray<DocumentType<Flyer>>;

src/entities/WeeklyDebrief.ts

@@ -2,6 +2,7 @@ import { Field, ID, ObjectType } from 'type-graphql';
 import { prop as Property, DocumentType } from '@typegoose/typegoose';
 import mongoose from 'mongoose';
 import { Article } from './Article';
+import { Magazine } from './Magazine';
 
 @ObjectType({ description: 'The Weekly Debrief Model' })
 export default class WeeklyDebrief {
@@ -36,6 +37,10 @@ export default class WeeklyDebrief {
   @Property({ required: true, type: () => Article, default: [] })
   readArticles: mongoose.Types.DocumentArray<DocumentType<Article>>;
 
+  @Field((type) => [Magazine])
+  @Property({ required: true, type: () => Magazine, default: [] })
+  readMagazines: mongoose.Types.DocumentArray<DocumentType<Magazine>>;
+
   @Field((type) => [Article])
   @Property({ required: true, type: () => Article, default: [] })
   randomArticles: mongoose.Types.DocumentArray<DocumentType<Article>>;

src/repos/UserRepo.ts

@@ -3,6 +3,8 @@ import { Article } from '../entities/Article';
 import ArticleRepo from './ArticleRepo';
 import { PublicationSlug } from '../common/types';
 import { User, UserModel } from '../entities/User';
+import { Magazine } from '../entities/Magazine';
+import MagazineRepo from './MagazineRepo';
 
 /**
  * Create new user associated with deviceToken and followedPublicationsSlugs of deviceType.
@@ -96,6 +98,25 @@ const appendReadArticle = async (uuid: string, articleID: string): Promise<User>
   return user;
 };
 
+/**
+ * Add a magazine to a user's readMagazines
+ */
+const appendReadMagazine = async (uuid: string, magazineID: string): Promise<User> => {
+  const user = await UserModel.findOne({ uuid });
+
+  if (!user) return user;
+
+  const magazine = await MagazineRepo.getMagazineByID(magazineID);
+  const checkDuplicates = (prev: boolean, cur: Magazine) => prev || cur.id === magazineID;
+
+  if (magazine && !user.readMagazines.reduce(checkDuplicates, false)) {
+    user.readMagazines.push(magazine);
+  }
+
+  user.save();
+  return user;
+};
+
 /**
  * Increment shoutouts in user's numShoutouts
  */
@@ -126,6 +147,7 @@ const incrementBookmarks = async (uuid: string): Promise<User> => {
 
 export default {
   appendReadArticle,
+  appendReadMagazine,
   createUser,
   followPublication,
   getUserByUUID,

src/repos/WeeklyDebriefRepo.ts

@@ -24,14 +24,17 @@ const createWeeklyDebrief = async (
     numShoutouts: user.numShoutouts,
     numBookmarkedArticles: user.numBookmarkedArticles,
     readArticles: user.readArticles.slice(0, 2),
+    readMagazines: user.readMagazines.slice(0, 2),
     numReadArticles: user.readArticles.length,
+    numReadMagazines: user.readMagazines.length,
     randomArticles: await articleAggregate.sample(2).exec(),
   });
   return UserModel.findOneAndUpdate(
     { uuid },
     {
       $set: {
         readArticles: [],
+        readMagazines: [],
         numShoutouts: 0,
         numBookmarkedArticles: 0,
         weeklyDebrief,

src/resolvers/UserResolver.ts

@@ -50,6 +50,14 @@ class UserResolver {
     return await UserRepo.appendReadArticle(uuid, articleID);
   }
 
+  @Mutation((_returns) => User, {
+    nullable: true,
+    description: "Adds the <Magazine> given by the <magazineID> to the <User's> read magazines",
+  })
+  async readMagazine(@Arg('uuid') uuid: string, @Arg('magazineID') magazineID: string) {
+    return await UserRepo.appendReadMagazine(uuid, magazineID);
+  }
+
   @Mutation((_returns) => User, {
     nullable: true,
     description: 'Increments the number of bookmarks for the <User> given by <uuid>',

src/tests/data/MagazineFactory.ts

@@ -0,0 +1,56 @@
+/* eslint-disable no-underscore-dangle */
+import { faker } from '@faker-js/faker';
+import { _ } from 'underscore';
+import PublicationFactory from './PublicationFactory';
+import { Magazine } from '../../entities/Magazine';
+import FactoryUtils from './FactoryUtils';
+
+class MagazineFactory {
+  public static async create(n: number): Promise<Magazine[]> {
+    /**
+     * Returns a list of n number of random Magazine objects
+     */
+    return Promise.all(FactoryUtils.create(n, MagazineFactory.fake));
+  }
+
+  public static async createSpecific(
+    n: number,
+    newMappings: { [key: string]: any },
+  ): Promise<Magazine[]> {
+    /**
+     * Returns a list of n number of random Magazine objects with specified
+     * field values in new Mappings
+     */
+    const arr = await MagazineFactory.create(n);
+    return arr.map((x) => {
+      const newDoc = x;
+      Object.entries(newMappings).forEach(([k, v]) => {
+        newDoc[k] = v;
+      });
+      return newDoc;
+    });
+  }
+
+  public static async fake(): Promise<Magazine> {
+    /**
+     * Returns a Magazine with random values in its instance variables
+     */
+    const fakeMagazine = new Magazine();
+    const examplePublication = await PublicationFactory.getRandomPublication();
+
+    fakeMagazine.date = faker.date.past();
+    fakeMagazine.semester = _.sample(['FA22', 'SP23']);
+    fakeMagazine.pdfURL = faker.image.cats();
+    fakeMagazine.publication = examplePublication;
+    fakeMagazine.publicationSlug = examplePublication.slug;
+    fakeMagazine.shoutouts = _.random(0, 50);
+    fakeMagazine.title = faker.commerce.productDescription();
+    fakeMagazine.nsfw = _.sample([true, false]);
+    fakeMagazine.isFeatured = _.sample([true, false]);
+    fakeMagazine.trendiness = 0;
+    fakeMagazine.isFiltered = _.sample([true, false]);
+
+    return fakeMagazine;
+  }
+}
+export default MagazineFactory;

src/tests/data/UserFactory.ts

@@ -0,0 +1,55 @@
+/* eslint-disable no-underscore-dangle */
+import { faker } from '@faker-js/faker';
+import { _ } from 'underscore';
+import { User } from '../../entities/User';
+import FactoryUtils from './FactoryUtils';
+
+class UserFactory {
+  public static async create(n: number): Promise<User[]> {
+    /**
+     * Returns a list of n number of random User objects
+     *
+     * @param n The number of desired random User objects
+     * @returns A Promise of the list of n number of random User objects
+     */
+    return Promise.all(FactoryUtils.create(n, UserFactory.fake));
+  }
+
+  public static async createSpecific(
+    n: number,
+    newMappings: { [key: string]: any },
+  ): Promise<User[]> {
+    /**
+     * Returns a list of n number of random User objects with specified
+     * fields values in newMappings
+     *
+     * @param n The number of desired random User objects
+     * @param newMappings The specified values for User parameters [key]
+     * @returns A Promise of the list of n number of random User objects
+     */
+    const arr = await UserFactory.create(n);
+    return arr.map((x) => {
+      const newDoc = x;
+      Object.entries(newMappings).forEach(([k, v]) => {
+        newDoc[k] = v;
+      });
+      return newDoc;
+    });
+  }
+
+  public static async fake(): Promise<User> {
+    /**
+     * Returns a User with random values in its instance variables
+     *
+     * @returns The User object with random values in its instance variables
+     */
+    const fakeUser = new User();
+
+    fakeUser.deviceToken = faker.datatype.string();
+    fakeUser.deviceType = _.sample(['IOS', 'ANDROID']);
+    fakeUser.uuid = faker.datatype.uuid();
+
+    return fakeUser;
+  }
+}
+export default UserFactory;