fix(model): add parent role and remove handle prop

Author: nicholaschiang

lib/model/analytics.ts

@@ -36,10 +36,11 @@ export type TagTotals<Tag extends string> = { total: number } & {
  * is updated until 24 hours have passed (and a new analytics doc is created).
  */
 export interface AnalyticsInterface extends ResourceInterface {
-  mentor: TagTotals<Exclude<UserTag, Role>>;
-  mentee: TagTotals<Exclude<UserTag, Role>>;
   tutor: TagTotals<Exclude<UserTag, Role>>;
   tutee: TagTotals<Exclude<UserTag, Role>>;
+  mentor: TagTotals<Exclude<UserTag, Role>>;
+  mentee: TagTotals<Exclude<UserTag, Role>>;
+  parent: TagTotals<Exclude<UserTag, Role>>;
   match: TagTotals<MatchTag>;
   meeting: TagTotals<MeetingTag>;
   ref?: DocumentReference;
@@ -59,28 +60,35 @@ export type AnalyticsFirestore = Omit<
   ResourceFirestore & { date: Timestamp };
 
 export class Analytics extends Resource implements AnalyticsInterface {
-  public mentor: TagTotals<Exclude<UserTag, Role>> = {
+  public tutor: TagTotals<Exclude<UserTag, Role>> = {
     total: 0,
     vetted: 0,
     matched: 0,
     meeting: 0,
   };
 
-  public mentee: TagTotals<Exclude<UserTag, Role>> = {
+  public tutee: TagTotals<Exclude<UserTag, Role>> = {
     total: 0,
     vetted: 0,
     matched: 0,
     meeting: 0,
   };
 
-  public tutor: TagTotals<Exclude<UserTag, Role>> = {
+  public mentor: TagTotals<Exclude<UserTag, Role>> = {
     total: 0,
     vetted: 0,
     matched: 0,
     meeting: 0,
   };
 
-  public tutee: TagTotals<Exclude<UserTag, Role>> = {
+  public mentee: TagTotals<Exclude<UserTag, Role>> = {
+    total: 0,
+    vetted: 0,
+    matched: 0,
+    meeting: 0,
+  };
+
+  public parent: TagTotals<Exclude<UserTag, Role>> = {
     total: 0,
     vetted: 0,
     matched: 0,

lib/model/match.ts

@@ -1,6 +1,5 @@
 import * as admin from 'firebase-admin';
 import { ObjectWithObjectID } from '@algolia/client-search';
-import { v4 as uuid } from 'uuid';
 
 import { Person, isPerson } from 'lib/model/person';
 import {
@@ -90,7 +89,6 @@ export class Match extends Resource implements MatchInterface {
     id: '',
     name: '',
     photo: '',
-    handle: uuid(),
     roles: [],
   };
 

lib/model/meeting.ts

@@ -1,6 +1,5 @@
 import * as admin from 'firebase-admin';
 import { ObjectWithObjectID } from '@algolia/client-search';
-import { v4 as uuid } from 'uuid';
 
 import {
   Match,
@@ -155,7 +154,6 @@ export class Meeting extends Resource implements MeetingInterface {
     id: '',
     name: '',
     photo: '',
-    handle: uuid(),
     roles: [],
   };
 

lib/model/person.ts

@@ -1,33 +1,29 @@
 import { isArray, isJSON } from 'lib/model/json';
 
-export type Role = 'tutor' | 'tutee' | 'mentor' | 'mentee';
+export type Role = 'tutor' | 'tutee' | 'mentor' | 'mentee' | 'parent';
 
 export function isRole(role: unknown): role is Role {
   if (typeof role !== 'string') return false;
-  return ['tutor', 'tutee', 'mentor', 'mentee'].includes(role);
+  return ['tutor', 'tutee', 'mentor', 'mentee', 'parent'].includes(role);
 }
 
 /**
  * Represents a person that is involved in a request or match. Here, roles are
  * explicitly listed (unlike the `User` object where roles are implied by
  * role-specific properties).
- * @property id - The user's unique Firebase-assigned user ID (note that this
- * contains both lowercase and capital letters which is why it can't be used as
- * a unique anonymous email address handle).
+ * @property id - The user's unique Firebase-assigned user ID.
  * @property [name] - The user's name (so we don't have to query an API just to
  * show an intelligible representation of this person).
  * @property [photo] - The user's photo URL (if any). This is included for the
  * same reason as above; speed on the front-end rendering. If not added by the
  * front-end, this is always updated by our back-end GCP function (triggered
  * when user documents are updated so as to keep profile info in sync).
- * @property handle - The user's all-lowercase anonymous email handle.
  * @property roles - The user's roles in this request or match (e.g. `tutor`).
  */
 export interface Person {
   id: string;
   name?: string;
   photo?: string;
-  handle: string;
   roles: Role[];
 }
 
@@ -36,7 +32,6 @@ export function isPerson(json: unknown): json is Person {
   if (typeof json.id !== 'string') return false;
   if (json.name && typeof json.name !== 'string') return false;
   if (json.photo && typeof json.photo !== 'string') return false;
-  if (typeof json.handle !== 'string') return false;
   if (!isArray(json.roles, isRole)) return false;
   return true;
 }

lib/model/user.ts

@@ -1,5 +1,4 @@
 import * as admin from 'firebase-admin';
-import { v4 as uuid } from 'uuid';
 
 import {
   Account,
@@ -54,19 +53,21 @@ export type UserTag =
 
 export type UserHitTag =
   | UserTag
-  | 'not-mentor'
-  | 'not-mentee'
   | 'not-tutor'
   | 'not-tutee'
+  | 'not-mentor'
+  | 'not-mentee'
+  | 'not-parent'
   | 'not-vetted'
   | 'not-matched'
   | 'not-meeting';
 
 export const USER_TAGS: UserTag[] = [
-  'mentor',
-  'mentee',
   'tutor',
   'tutee',
+  'mentor',
+  'mentee',
+  'parent',
   'vetted',
   'matched',
   'meeting',
@@ -98,6 +99,7 @@ export function isSubjects(json: unknown): json is Subjects {
  * A user object (that is stored in their Firestore profile document by uID).
  * @typedef {Object} UserInterface
  * @extends AccountInterface
+ * @property [age] - The user's age (mostly used for students).
  * @property orgs - An array of the IDs of the orgs this user belongs to.
  * @property zooms - An array of Zoom user accounts. These are used when
  * creating Zoom meetings for a match. Each TB user can have multiple Zoom user
@@ -122,6 +124,7 @@ export function isSubjects(json: unknown): json is Subjects {
  * meetings).
  */
 export interface UserInterface extends AccountInterface {
+  age?: number;
   orgs: string[];
   zooms: ZoomUser[];
   availability: Availability;
@@ -174,6 +177,7 @@ export type UserSearchHit = Omit<
 export function isUserJSON(json: unknown): json is UserJSON {
   if (!isAccountJSON(json)) return false;
   if (!isJSON(json)) return false;
+  if (json.age && typeof json.age !== 'number') return false;
   if (!isStringArray(json.orgs)) return false;
   if (!isArray(json.zooms, isZoomUserJSON)) return false;
   if (!isAvailabilityJSON(json.availability)) return false;
@@ -198,6 +202,8 @@ export function isUserJSON(json: unknown): json is UserJSON {
  * @see {@link https://stackoverflow.com/a/54857125/10023158}
  */
 export class User extends Account implements UserInterface {
+  public age?: number;
+
   public orgs: string[] = [];
 
   public zooms: ZoomUser[] = [];
@@ -259,13 +265,17 @@ export class User extends Account implements UserInterface {
     return parts[parts.length - 1];
   }
 
+  public get subjects(): string[] {
+    const subjects = this.tutoring.subjects.concat(this.mentoring.subjects);
+    return [...new Set<string>(subjects)];
+  }
+
   public toPerson(): Person {
     return {
       id: this.id,
       name: this.name,
       photo: this.photo,
       roles: this.roles,
-      handle: uuid(),
     };
   }
 

scripts/firebase/picktime.js

@@ -9,7 +9,6 @@ const prompt = require('prompt-sync')();
 const algoliasearch = require('algoliasearch');
 const parseSync = require('csv-parse/lib/sync');
 const { default: to } = require('await-to-js');
-const { v4: uuid } = require('uuid');
 const { nanoid } = require('nanoid');
 
 const logger = winston.createLogger({
@@ -295,22 +294,19 @@ async function convertPicktimeRow(row, headers) {
           id: student.id || '',
           name: student.name || '',
           photo: student.photo || '',
-          handle: uuid(),
           roles: ['mentee'],
         },
         {
           id: mentor.id || '',
           name: mentor.name || '',
           photo: mentor.photo || '',
-          handle: uuid(),
           roles: ['mentor'],
         },
       ],
       creator: {
         id: student.id || '',
         name: student.name || '',
         photo: student.photo || '',
-        handle: uuid(),
         roles: ['mentee'],
       },
       message: generateMatchMessage(row),
@@ -354,7 +350,6 @@ async function convertPicktimeRow(row, headers) {
       id: student.id || '',
       name: student.name || '',
       photo: student.photo || '',
-      handle: uuid(),
       roles: ['mentee'],
     },
     venue: {

scripts/firebase/utils.js

@@ -23,7 +23,6 @@ console.log(
   )
 );
 
-const { v4: uuid } = require('uuid');
 const { nanoid } = require('nanoid');
 const axios = require('axios');
 const updateSubjects = require('./update-subjects');
@@ -562,7 +561,6 @@ const changeDateJSONToDates = async () => {
       id: '',
       name: '',
       photo: '',
-      handle: uuid(),
       roles: [],
     },
     message: '',