Add volunteer type for NFC/event scanning (VandyHacks#479)

* Add volunteer type
* Add new func to check authorized against array of usertypes
* Only let organizers register user with NFC id
* Add volunteer schema types
* Make volunteers resolve
* Fix something that's not an issue

Author: cktang88

codegen.json

@@ -5,11 +5,7 @@
 	"watch": false,
 	"generates": {
 		"src/server/generated/graphql.ts": {
-			"plugins": [
-				"typescript",
-				"typescript-resolvers",
-				"typescript-mongodb"
-			],
+			"plugins": ["typescript", "typescript-resolvers", "typescript-mongodb"],
 			"config": {
 				"mappers": {
 					"ApplicationField": "ApplicationFieldDbObject",
@@ -22,10 +18,11 @@
 					"Mentor": "MentorDbObject",
 					"Organizer": "OrganizerDbObject",
 					"Shift": "ShiftDbObject",
-				  	"Sponsor": "SponsorDbObject",
-				  	"Team": "TeamDbObject",
-				  	"Tier": "TierDbObject",
-					"User": "UserDbInterface"
+					"Sponsor": "SponsorDbObject",
+					"Team": "TeamDbObject",
+					"Tier": "TierDbObject",
+					"User": "UserDbInterface",
+					"Volunteer": "VolunteerDbObject"
 				},
 				"skipTypenames": false
 			}

src/client/assets/routes.js

@@ -20,7 +20,7 @@ const routes = [
 		path: '/dashboard',
 	},
 	{
-		authLevel: [UserType.Hacker],
+		authLevel: [UserType.Hacker, UserType.Volunteer],
 		component: HackerDash,
 		displayText: 'Dashboard',
 		path: '/dashboard',
@@ -38,7 +38,7 @@ const routes = [
 		path: '/dashboard',
 	},
 	{
-		authLevel: [UserType.Hacker],
+		authLevel: [UserType.Hacker, UserType.Volunteer, UserType.Organizer],
 		component: Application,
 		displayText: 'Apply',
 		path: '/application',
@@ -74,13 +74,13 @@ const routes = [
 		path: '/manage/sponsors',
 	},
 	{
-		authLevel: [UserType.Hacker, UserType.Sponsor, UserType.Organizer],
+		authLevel: [UserType.Hacker, UserType.Sponsor, UserType.Volunteer],
 		component: Help,
 		displayText: 'Help',
 		path: '/help',
 	},
 	{
-		authLevel: [UserType.Organizer, UserType.Sponsor],
+		authLevel: [UserType.Organizer, UserType.Volunteer, UserType.Sponsor],
 		component: Nfc,
 		displayText: 'Scan NFC',
 		path: '/nfc',

src/common/schema.graphql.ts

@@ -19,12 +19,6 @@ export default gql`
 		eventsAttended: [ID!]! @column
 	}
 
-	enum AuthLevel {
-		HACKER
-		ORGANIZER
-		SPONSOR
-	}
-
 	enum DietaryRestriction {
 		VEGETARIAN
 		VEGAN
@@ -87,6 +81,7 @@ export default gql`
 		ORGANIZER
 		SPONSOR
 		SUPER_ADMIN
+		VOLUNTEER
 	}
 
 	enum SortDirection {
@@ -248,6 +243,35 @@ export default gql`
 		eventsAttended: [ID!]! @column
 	}
 
+	type Volunteer implements User @entity {
+		id: ID! @id
+		createdAt: Float!
+		secondaryIds: [ID!]!
+		logins: [Login!]!
+		email: String!
+		firstName: String!
+		preferredName: String!
+		lastName: String!
+		shirtSize: ShirtSize
+		gender: String
+		dietaryRestrictions: String!
+		userType: UserType!
+		phoneNumber: String
+		race: String! @column
+		modifiedAt: Float! @column
+		status: ApplicationStatus! @column
+		school: String @column
+		gradYear: String @column
+		majors: [String!]! @column
+		adult: Boolean @column
+		volunteer: String @column
+		github: String @column
+		team: Team @embedded
+		eventsAttended: [ID!]! @column
+		application: [ApplicationField!]! @embedded
+		emailUnsubscribed: Boolean! @column
+	}
+
 	type Query {
 		company(id: ID!): Company!
 		companies(sortDirection: SortDirection): [Company!]!

src/server/resolvers/helpers.ts

@@ -124,7 +124,7 @@ export async function fetchUser(
 	{ email, userType }: { email: string; userType: string },
 	models: Models
 ): Promise<UserDbInterface> {
-	if (userType === UserType.Hacker) {
+	if (userType === UserType.Hacker || userType === UserType.Volunteer) {
 		return query({ email }, models.Hackers);
 	}
 	if (userType === UserType.Organizer) {
@@ -152,6 +152,26 @@ export function checkIsAuthorized<T extends UserDbInterface>(requiredType: UserT
 
 	return user;
 }
+
+/**
+ * Funtion to check if the user has the authorization required to continue (checks an ARRAY of types))
+ * If not, the function will throw a GraphQL AuthenticationError.
+ * @param requiredType The authorization level the user should have.
+ * @param user The user to check against requiredType.
+ * @returns The user object, coerced to a non-null type.
+ */
+export function checkIsAuthorizedArray<T extends UserDbInterface>(
+	requiredTypes: UserType[],
+	user?: T
+): T {
+	if (!user || !requiredTypes.includes(user.userType as UserType)) {
+		throw new AuthenticationError(
+			`user ${user && user.email}: ${JSON.stringify(user)} must be one of "${requiredTypes}"`
+		);
+	}
+
+	return user;
+}
 /**
  * Replaces the resume field with a signed URL
  * @param appFields Fields to search for a resume field to replace

src/server/resolvers/index.ts

@@ -20,6 +20,7 @@ import {
 	updateUser,
 	checkIsAuthorized,
 	replaceResumeFieldWithLink,
+	checkIsAuthorizedArray,
 } from './helpers';
 import { checkInUserToEvent, removeUserFromEvent, registerNFCUIDWithUser, getUser } from '../nfc';
 import { addOrUpdateEvent } from '../events';
@@ -51,7 +52,9 @@ const requiredFields = [
  */
 export type CustomResolvers<T> = Omit<Resolvers<T>, 'User'> & {
 	User: {
-		__resolveType: (user: UserDbInterface) => 'Hacker' | 'Mentor' | 'Organizer' | 'Sponsor';
+		__resolveType: (
+			user: UserDbInterface
+		) => 'Hacker' | 'Mentor' | 'Organizer' | 'Sponsor' | 'Volunteer';
 	};
 };
 
@@ -76,6 +79,30 @@ const userResolvers: Omit<UserResolvers, '__resolveType' | 'userType'> = {
 	},
 };
 
+const hackerResolvers: CustomResolvers<Context>['Hacker'] = {
+	...userResolvers,
+	adult: async hacker => (await hacker).adult || null,
+	application: async (hacker, args, { models }: Context) =>
+		replaceResumeFieldWithLink(
+			models.ApplicationFields.find({ userId: (await hacker)._id }).toArray()
+		),
+	gender: async hacker => (await hacker).gender || null,
+	github: async hacker => (await hacker).github || null,
+	gradYear: async hacker => (await hacker).gradYear || null,
+	majors: async hacker => (await hacker).majors || [],
+	modifiedAt: async hacker => (await hacker).modifiedAt,
+	race: async hacker => (await hacker).race || '',
+	school: async hacker => (await hacker).school || null,
+	status: async hacker => toEnum(ApplicationStatus)((await hacker).status),
+	team: async (hacker, args, { models }) => {
+		const team = await models.UserTeamIndicies.findOne({ email: (await hacker).email });
+		if (!team) return { _id: new ObjectID(), createdAt: new Date(0), memberIds: [], name: '' };
+		return query({ name: team.team }, models.Teams);
+	},
+	userType: () => UserType.Hacker,
+	volunteer: async hacker => (await hacker).volunteer || null,
+};
+
 export const resolvers: CustomResolvers<Context> = {
 	/**
 	 * These resolvers are for querying fields
@@ -114,28 +141,10 @@ export const resolvers: CustomResolvers<Context> = {
 		name: async tier => (await tier).name,
 		permissions: async tier => (await tier).permissions,
 	},
-	Hacker: {
-		...userResolvers,
-		adult: async hacker => (await hacker).adult || null,
-		application: async (hacker, args, { models }: Context) =>
-			replaceResumeFieldWithLink(
-				models.ApplicationFields.find({ userId: (await hacker)._id }).toArray()
-			),
-		gender: async hacker => (await hacker).gender || null,
-		github: async hacker => (await hacker).github || null,
-		gradYear: async hacker => (await hacker).gradYear || null,
-		majors: async hacker => (await hacker).majors || [],
-		modifiedAt: async hacker => (await hacker).modifiedAt,
-		race: async hacker => (await hacker).race || '',
-		school: async hacker => (await hacker).school || null,
-		status: async hacker => toEnum(ApplicationStatus)((await hacker).status),
-		team: async (hacker, args, { models }) => {
-			const team = await models.UserTeamIndicies.findOne({ email: (await hacker).email });
-			if (!team) return { _id: new ObjectID(), createdAt: new Date(0), memberIds: [], name: '' };
-			return query({ name: team.team }, models.Teams);
-		},
-		userType: () => UserType.Hacker,
-		volunteer: async hacker => (await hacker).volunteer || null,
+	Hacker: hackerResolvers,
+	Volunteer: {
+		...hackerResolvers,
+		userType: () => UserType.Volunteer,
 	},
 	Login: {
 		createdAt: async login => (await login).createdAt.getTime(),
@@ -164,7 +173,7 @@ export const resolvers: CustomResolvers<Context> = {
 			return addOrUpdateEvent(input, models);
 		},
 		checkInUserToEvent: async (root, { input }, { models, user }) => {
-			checkIsAuthorized(UserType.Organizer, user);
+			checkIsAuthorizedArray([UserType.Organizer, UserType.Volunteer, UserType.Sponsor], user);
 			const userRet = await checkInUserToEvent(input.user, input.event, models);
 			return userRet;
 		},
@@ -265,7 +274,7 @@ export const resolvers: CustomResolvers<Context> = {
 			return companyCreated;
 		},
 		checkInUserToEventByNfc: async (root, { input }, { models, user }) => {
-			checkIsAuthorized(UserType.Organizer, user);
+			checkIsAuthorizedArray([UserType.Organizer, UserType.Volunteer, UserType.Sponsor], user);
 			const inputUser = await getUser(input.nfcId, models);
 			if (inputUser) {
 				const userRet = await checkInUserToEvent(inputUser._id.toString(), input.event, models);
@@ -364,12 +373,12 @@ export const resolvers: CustomResolvers<Context> = {
 			return userRet;
 		},
 		removeUserFromEvent: async (root, { input }, { models, user }) => {
-			checkIsAuthorized(UserType.Organizer, user);
+			checkIsAuthorizedArray([UserType.Organizer, UserType.Volunteer, UserType.Sponsor], user);
 			const userRet = await removeUserFromEvent(input.user, input.event, models);
 			return userRet;
 		},
 		removeUserFromEventByNfc: async (root, { input }, { models, user }) => {
-			checkIsAuthorized(UserType.Organizer, user);
+			checkIsAuthorizedArray([UserType.Organizer, UserType.Volunteer, UserType.Sponsor], user);
 			const inputUser = await getUser(input.nfcId, models);
 			if (inputUser) {
 				const userRet = await removeUserFromEvent(inputUser._id.toString(), input.event, models);
@@ -561,6 +570,8 @@ export const resolvers: CustomResolvers<Context> = {
 					return 'Organizer';
 				case UserType.Sponsor:
 					return 'Sponsor';
+				case UserType.Volunteer:
+					return 'Volunteer';
 				default:
 					throw new AuthenticationError(`cannot decode UserType "${user.userType}`);
 			}