Setup typeorm

.eslintrc.yml

@@ -2,7 +2,7 @@ extends:
   - "eslint:recommended"
   - "airbnb-typescript/base"
 parserOptions:
-  project: './tsconfig.json'
+  project: "./tsconfig.json"
 env:
   browser: true
   node: true
@@ -13,8 +13,9 @@ rules:
   "@typescript-eslint/no-unused-vars":
     - "error"
     - argsIgnorePattern: "type|_*"
+  "@typescript-eslint/indent": "off"
   class-methods-use-this: "off"
-  consistent-return: off
+  consistent-return: "off"
   func-names: "off"
   global-require: "off"
   import/no-cycle: "off"

.github/CODEOWNERS

@@ -1 +1 @@
-*	@echang594
+*	@echang594 @jennymar

.github/workflows/auto-comment.yml

@@ -1,7 +1,9 @@
 name: Auto Comment on PRs
-on: pull_request
+on:
+  pull_request:
+    types: [opened]
 jobs:
-  run:
+  auto-comment:
     runs-on: ubuntu-latest
     steps:
       - uses: wow-actions/auto-comment@v1

DataSource.ts

@@ -0,0 +1,17 @@
+import Container from 'typedi';
+import { DataSource } from 'typeorm';
+import { models } from './models';
+
+export const dataSource = new DataSource({
+  type: 'postgres',
+  host: process.env.RDS_HOST,
+  port: Number(process.env.RDS_PORT),
+  username: process.env.RDS_USER,
+  password: process.env.RDS_PASSWORD,
+  database: process.env.RDS_DATABASE,
+  entities: models,
+  synchronize: true, // DO NOT USE IN PRODUCTION, make migrations
+});
+
+// important for dependency injection for repositories
+Container.set(DataSource, dataSource);

docker-compose.yml

@@ -1,6 +1,6 @@
 services:
-  rds.acmucsd.local:
-    container_name: rds.acmucsd.local
+  rds.hackathon.acmucsd.local:
+    container_name: rds.hackathon.acmucsd.local
     image: postgres:17
     restart: always
     ports:

firebaseConfig.ts

@@ -14,4 +14,4 @@ const firebaseConfig = {
 const app = initializeApp(firebaseConfig);
 const auth = getAuth(app);
 
-export { auth };
+export { auth };

index.ts

@@ -1,12 +1,15 @@
-import { register, login } from './authService';
-
-register('[email protected]', 'password')
-  .then((user) => {
-    console.log('registered user:', user);
-  });
+import 'reflect-metadata';
 
+// must import data source before using repositories
+import { dataSource } from './DataSource';
 
-login('[email protected]', 'mysecretpassword')
-  .then((user) => {
-    console.log('login user:', user);
+dataSource
+  .initialize()
+  .then(() => {
+    console.log('created connection');
+  })
+  .catch((error) => {
+    console.log(error);
   });
+
+console.log('Hello World!');

models/UserModel.ts

@@ -0,0 +1,43 @@
+import { Column, Entity, PrimaryColumn } from 'typeorm';
+import { ApplicationStatus, UserAccessType } from '../types/Enums';
+
+@Entity()
+export class UserModel {
+  @PrimaryColumn()
+  uid: string;
+
+  @Column()
+  email: string;
+
+  @Column()
+  firstName: string;
+
+  @Column()
+  lastName: string;
+
+  @Column({
+    type: 'enum',
+    enum: UserAccessType,
+    default: UserAccessType.STANDARD,
+  })
+  accessType: UserAccessType;
+
+  @Column({
+    type: 'enum',
+    enum: ApplicationStatus,
+    default: ApplicationStatus.NOT_SUBMITTED,
+  })
+  applicationStatus: ApplicationStatus;
+
+  public isRestricted(): boolean {
+    return this.accessType === UserAccessType.RESTRICTED;
+  }
+
+  public isManager(): boolean {
+    return this.accessType === UserAccessType.MANAGER;
+  }
+
+  public isAdmin(): boolean {
+    return this.accessType === UserAccessType.ADMIN;
+  }
+}

models/index.ts

@@ -0,0 +1,3 @@
+import { UserModel } from './UserModel';
+
+export const models = [UserModel];

package.json

@@ -5,7 +5,8 @@
   "main": "index.js",
   "scripts": {
     "build": "tsc",
-    "start": "nodemon index.ts",
+    "start": "node build/index.js",
+    "dev": "node -r ts-node/register --env-file=.env --watch index.ts",
     "test": "jest --config jest.config.json --runInBand",
     "release": "node build/index.js",
     "lint": "eslint ./ --ext .ts",
@@ -14,20 +15,23 @@
   "repository": "https://github.com/acmucsd/hackathon-portal.git",
   "author": "Eric Chang <[email protected]>",
   "dependencies": {
-    "dotenv": "^16.4.5",
+    "pg": "^8.13.1",
+    "reflect-metadata": "^0.2.2",
+    "typedi": "^0.10.0",
+    "typeorm": "^0.3.20",
     "firebase": "^11.0.1"
   },
   "devDependencies": {
     "@types/jest": "^29.5.13",
+    "@types/node": "^22.7.9",
     "@typescript-eslint/eslint-plugin": "^7.0.0",
     "@typescript-eslint/parser": "^7.0.0",
     "eslint": "^8.57.1",
     "eslint-config-airbnb-typescript": "^18.0.0",
     "eslint-plugin-import": "^2.31.0",
     "jest": "^29.7.0",
-    "nodemon": "^3.0.2",
     "ts-jest": "^29.2.5",
-    "ts-node-dev": "^2.0.0",
+    "ts-node": "^10.9.2",
     "typescript": "^5.6.3"
   }
 }

repositories/UserRepository.ts

@@ -0,0 +1,24 @@
+import { DataSource, In } from 'typeorm';
+import { UserModel } from '../models/UserModel';
+import Container from 'typedi';
+import { Uid } from '../types/Internal';
+
+export const UserRepository = Container.get(DataSource)
+  .getRepository(UserModel)
+  .extend({
+    async findAll(): Promise<UserModel[]> {
+      return this.find();
+    },
+
+    async findByUid(uid: Uid): Promise<UserModel | null> {
+      return this.findOneBy({ uid });
+    },
+
+    async findByEmail(email: string): Promise<UserModel | null> {
+      return this.findOneBy({ email });
+    },
+
+    async findByEmails(emails: string[]): Promise<UserModel[]> {
+      return this.findBy({ email: In(emails) });
+    },
+  });

repositories/index.ts

@@ -0,0 +1,27 @@
+import { Service } from 'typedi';
+import { DataSource, EntityManager } from 'typeorm';
+import { UserRepository } from './UserRepository';
+
+export class Repositories {
+  public static user(entityManager: EntityManager) {
+    return entityManager.withRepository(UserRepository);
+  }
+}
+
+@Service()
+export class TransactionsManager {
+  private dataSource: DataSource;
+
+  constructor(dataSource: DataSource) {
+    this.dataSource = dataSource;
+  }
+
+  // add automatic retries if transaction failing often - see membership portal
+  public readOnly<T>(fn: (entityManager: EntityManager) => Promise<T>) {
+    return this.dataSource.transaction('REPEATABLE READ', fn);
+  }
+
+  public readWrite<T>(fn: (entityManager: EntityManager) => Promise<T>) {
+    return this.dataSource.transaction('SERIALIZABLE', fn);
+  }
+}

services/UserService.ts

@@ -0,0 +1,21 @@
+import { Service } from 'typedi';
+import { Repositories, TransactionsManager } from '../repositories';
+import { UserModel } from '../models/UserModel';
+import { Uid } from '../types/Internal';
+
+@Service()
+export class UserService {
+  private transactionsManager: TransactionsManager;
+
+  constructor(transactionsManager: TransactionsManager) {
+    this.transactionsManager = transactionsManager;
+  }
+
+  public async findByUid(uid: Uid): Promise<UserModel> {
+    const user = await this.transactionsManager.readOnly(
+      async (entityManager) => Repositories.user(entityManager).findByUid(uid),
+    );
+    if (!user) throw new Error('User not found');
+    return user;
+  }
+}

authService.ts → tests/authService.ts

@@ -1,21 +1,39 @@
-import { auth } from './firebaseConfig';
-import { createUserWithEmailAndPassword, signInWithEmailAndPassword,
-  sendPasswordResetEmail, UserCredential } from 'firebase/auth';
+import { auth } from '../firebaseConfig';
+import {
+  createUserWithEmailAndPassword,
+  signInWithEmailAndPassword,
+  sendPasswordResetEmail,
+  UserCredential,
+} from 'firebase/auth';
 
-export const register = async (email: string, password: string): Promise<UserCredential | void> => {
+export const register = async (
+  email: string,
+  password: string,
+): Promise<UserCredential | void> => {
   try {
     console.log('authService.ts');
-    const userCredential: UserCredential = await createUserWithEmailAndPassword(auth, email, password);
+    const userCredential: UserCredential = await createUserWithEmailAndPassword(
+      auth,
+      email,
+      password,
+    );
     console.log('User registered:', userCredential.user);
     return userCredential;
   } catch (error) {
     console.error('Error registering user:', error);
   }
 };
 
-export const login = async (email: string, password: string): Promise<UserCredential | void> => {
+export const login = async (
+  email: string,
+  password: string,
+): Promise<UserCredential | void> => {
   try {
-    const userCredential: UserCredential = await signInWithEmailAndPassword(auth, email, password);
+    const userCredential: UserCredential = await signInWithEmailAndPassword(
+      auth,
+      email,
+      password,
+    );
     console.log('User logged in:', userCredential.user);
     return userCredential;
   } catch (error) {
@@ -30,4 +48,4 @@ export const resetPassword = async (email: string): Promise<void> => {
   } catch (error) {
     console.error('Error sending password reset email:', error);
   }
-};
+};

tsconfig.json

@@ -3,9 +3,12 @@
     "target": "es6",
     "module": "commonjs",
     "moduleResolution": "node",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
     "declaration": true,
     "outDir": "./build",
     "strict": true,
+    "strictPropertyInitialization": false,
     "skipLibCheck": true
   },
   "include": [

types/Enums.ts

@@ -0,0 +1,15 @@
+export enum UserAccessType {
+  RESTRICTED = 'RESTRICTED',
+  STANDARD = 'STANDARD',
+  MANAGER = 'MANAGER',
+  ADMIN = 'ADMIN',
+}
+
+export enum ApplicationStatus {
+  NOT_SUBMITTED = 'NOT_SUBMITTED',
+  SUBMITTED = 'SUBMITTED',
+  WITHDRAWN = 'WITHDRAWN',
+  ACCEPTED = 'ACCEPTED',
+  REJECTED = 'REJECTED',
+  ALL_DONE = 'ALL_DONE',
+}

types/Internal.ts

@@ -0,0 +1,2 @@
+export type Uid = string;
+export type Uuid = string;