#730 add user settings

src/backend/functions/users.ts

@@ -16,11 +16,33 @@ import {
   buildNotFoundResponse,
   buildSuccessResponse,
   routeMatcher,
-  User
+  User,
+  AuthenticatedUser
 } from 'utils';
 
 const prisma = new PrismaClient();
 
+const authUserQueryArgs = Prisma.validator<Prisma.UserArgs>()({
+  include: {
+    userSettings: true
+  }
+});
+
+const authenticatedUserTransformer = (
+  user: Prisma.UserGetPayload<typeof authUserQueryArgs>
+): AuthenticatedUser => {
+  return {
+    userId: user.userId,
+    firstName: user.firstName,
+    lastName: user.lastName,
+    googleAuthId: user.googleAuthId,
+    email: user.email,
+    emailId: user.emailId,
+    role: user.role,
+    defaultTheme: user.userSettings?.defaultTheme
+  };
+};
+
 const usersTransformer = (user: Prisma.UserGetPayload<null>): User => {
   if (user === null) throw new TypeError('User not found');
 
@@ -70,7 +92,10 @@ const logUserIn: ApiRouteFunction = async (_params, event) => {
   if (!payload) throw new Error('Auth server response payload invalid');
   const { sub: userId } = payload; // google user id
   // check if user is already in the database via Google ID
-  let user = await prisma.user.findUnique({ where: { googleAuthId: userId } });
+  let user = await prisma.user.findUnique({
+    where: { googleAuthId: userId },
+    ...authUserQueryArgs
+  });
 
   // if not in database, create user in database
   if (user === null) {
@@ -83,8 +108,10 @@ const logUserIn: ApiRouteFunction = async (_params, event) => {
         lastName: payload['family_name']!,
         googleAuthId: userId,
         email: payload['email']!,
-        emailId
-      }
+        emailId,
+        userSettings: { create: {} }
+      },
+      ...authUserQueryArgs
     });
     user = createdUser;
   }
@@ -97,7 +124,7 @@ const logUserIn: ApiRouteFunction = async (_params, event) => {
     }
   });
 
-  return buildSuccessResponse(usersTransformer(user));
+  return buildSuccessResponse(authenticatedUserTransformer(user));
 };
 
 // Define all valid routes for the endpoint

src/backend/prisma/migrations/20220625223108_add_user_settings/migration.sql

@@ -0,0 +1,25 @@
+/*
+  Warnings:
+
+  - A unique constraint covering the columns `[userSettingsId]` on the table `User` will be added. If there are existing duplicate values, this will fail.
+
+*/
+-- CreateEnum
+CREATE TYPE "Theme" AS ENUM ('LIGHT', 'DARK');
+
+-- AlterTable
+ALTER TABLE "User" ADD COLUMN     "userSettingsId" TEXT;
+
+-- CreateTable
+CREATE TABLE "UserSettings" (
+    "id" TEXT NOT NULL,
+    "defaultTheme" "Theme" NOT NULL DEFAULT E'DARK',
+
+    PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User.userSettingsId_unique" ON "User"("userSettingsId");
+
+-- AddForeignKey
+ALTER TABLE "User" ADD FOREIGN KEY ("userSettingsId") REFERENCES "UserSettings"("id") ON DELETE SET NULL ON UPDATE CASCADE;

src/backend/prisma/schema.prisma

@@ -32,6 +32,11 @@ enum Role {
   GUEST
 }
 
+enum Theme {
+  LIGHT
+  DARK
+}
+
 enum Scope_CR_Why_Type {
   ESTIMATION
   SCHOOL
@@ -53,6 +58,9 @@ model User {
   email                   String           @unique
   emailId                 String?          @unique
   role                    Role             @default(GUEST)
+  userSettingsId          String?          @unique
+  userSettings            UserSettings?    @relation(fields: [userSettingsId], references: [id])
+  // Relation references
   submittedChangeRequests Change_Request[] @relation(name: "submittedChangeRequests")
   reviewedChangeRequests  Change_Request[] @relation(name: "reviewedChangeRequests")
   markedAsProjectLead     Activation_CR[]  @relation(name: "markAsProjectLead")
@@ -74,6 +82,12 @@ model Session {
   deviceInfo String?
 }
 
+model UserSettings {
+  id           String @id @default(uuid())
+  user         User?
+  defaultTheme Theme  @default(DARK)
+}
+
 model Change_Request {
   crId                    Int            @id @default(autoincrement())
   submitterId             Int

src/backend/prisma/seed-data/risks.ts

@@ -5,14 +5,18 @@
 
 const dbSeedRisk1: any = {
   projectId: 1,
-  detail: 'This one might be a bit too expensive',
-  createdByUserId: 1
+  createdByUserId: 1,
+  fields: {
+    detail: 'This one might be a bit too expensive'
+  }
 };
 
 const dbSeedRisk2: any = {
   projectId: 1,
-  detail: 'Risky Risk 123',
-  createdByUserId: 1
+  createdByUserId: 1,
+  fields: {
+    detail: 'Risky Risk 123'
+  }
 };
 
 export const dbSeedAllRisks: any[] = [dbSeedRisk1, dbSeedRisk2];

src/backend/prisma/seed.ts

@@ -15,7 +15,7 @@ const prisma = new PrismaClient();
 
 const performSeed: () => Promise<void> = async () => {
   for (const seedUser of dbSeedAllUsers) {
-    await prisma.user.create({ data: { ...seedUser } });
+    await prisma.user.create({ data: { ...seedUser, userSettings: { create: {} } } });
   }
 
   for (const seedSession of dbSeedAllSessions) {
@@ -44,7 +44,7 @@ const performSeed: () => Promise<void> = async () => {
       data: {
         createdBy: { connect: { userId: seedRisk.createdByUserId } },
         project: { connect: { projectId: seedRisk.projectId } },
-        ...seedRisk
+        ...seedRisk.fields
       }
     });
   }

src/frontend/pages/LoginPage/login.tsx

@@ -8,10 +8,10 @@ import { useHistory } from 'react-router';
 import { Role } from '@prisma/client';
 import { exampleAllUsers } from '../../../test-support/test-data/users.stub';
 import { useAuth } from '../../../services/auth.hooks';
-import LoginPage from './login-page/login-page';
-import './login.module.css';
 import { routes } from '../../../shared/routes';
+import LoginPage from './login-page/login-page';
 import LoadingIndicator from '../../components/loading-indicator/loading-indicator';
+import './login.module.css';
 
 interface LoginProps {
   postLoginRedirect: { url: string; search: string };

src/services/auth.hooks.ts

@@ -4,7 +4,7 @@
  */
 
 import { useState, useContext } from 'react';
-import { User } from '@prisma/client';
+import { User } from 'utils';
 import { AuthContext } from '../frontend/app/app-context-auth/app-context-auth';
 import { useLogUserIn } from './users.hooks';
 import { Auth } from '../shared/types';

src/shared/pipes.ts

@@ -3,8 +3,7 @@
  * See the LICENSE file in the repository root folder for details.
  */
 
-import { User } from '@prisma/client';
-import { WbsNumber } from 'utils';
+import { WbsNumber, User } from 'utils';
 
 /**
  * Pipes:

src/shared/types.ts

@@ -3,7 +3,7 @@
  * See the LICENSE file in the repository root folder for details.
  */
 
-import { User } from '@prisma/client';
+import { User } from 'utils';
 import { IconProp } from '@fortawesome/fontawesome-svg-core';
 
 export interface Auth {

src/test-support/test-data/users.stub.ts

@@ -3,7 +3,8 @@
  * See the LICENSE file in the repository root folder for details.
  */
 
-import { User, Role } from '@prisma/client';
+import { User } from 'utils';
+import { Role } from '@prisma/client';
 
 export const exampleAppAdminUser: User = {
   userId: 1,

src/utils/src/types/user-types.ts

@@ -14,3 +14,19 @@ export interface User {
 }
 
 export type Role = 'APP_ADMIN' | 'ADMIN' | 'LEADERSHIP' | 'MEMBER' | 'GUEST';
+
+export type Theme = 'DARK' | 'LIGHT';
+
+/**
+ * User object used purely for authentication purposes.
+ */
+export interface AuthenticatedUser {
+  userId: number;
+  firstName: string;
+  lastName: string;
+  googleAuthId: string;
+  email: string;
+  emailId: string | null;
+  role: Role;
+  defaultTheme?: Theme;
+}