Merge pull request #94 from icefoganalytics/test

Portal models and MSFAA column migration

Author: datajohnson

Design/Entity Relationship Diagrams.png

@@ -37,7 +37,7 @@ services:
       <<: *environment-definition
       NODE_ENV: test
       DB_NAME: sfa_client_test
-      DB_DEFAULT_SCHEMA: dbo
+      DB_DEFAULT_SCHEMA: sfa
     tty: true
     volumes:
       - ./src/api:/usr/src/api
@@ -85,6 +85,16 @@ services:
       - 8081:8080
       - 8085:8085
 
+  # For easily generating large PlantUML diagrams
+  # Not relevant to production environment.
+  # Accessible at http://localhost:9999
+  plantuml:
+    image: plantuml/plantuml-server:jetty
+    ports:
+      - 9999:8080
+    environment:
+      PLANTUML_LIMIT_SIZE: 8192
+
 volumes:
   db_data:
   s3storage:

Design/Entity Relationship Diagrams.wsd

@@ -0,0 +1,17 @@
+import { Request, Response, NextFunction } from "express"
+
+export default class BaseController {
+  protected request: Request
+  protected response: Response
+  protected next: NextFunction
+
+  constructor(request: Request, response: Response, next: NextFunction) {
+    this.request = request
+    this.response = response
+    this.next = next
+  }
+
+  protected get params() {
+    return this.request.params
+  }
+}

docker-compose.development.yaml

@@ -0,0 +1,19 @@
+import { Request, Response, NextFunction } from "express"
+
+import BaseController from "@/controllers/base-controller"
+
+export function routedTo<T extends typeof BaseController>(
+  controllerClass: T,
+  method: string & keyof InstanceType<T>
+) {
+  return (req: Request, res: Response, next: NextFunction) => {
+    const controllerInstance = new controllerClass(req, res, next) as InstanceType<T>
+    const unboundControllerMethod = controllerInstance[method]
+
+    if (typeof unboundControllerMethod === "function") {
+      return unboundControllerMethod.call(controllerInstance)
+    } else {
+      throw new Error(`Method ${method} is not a function on the provided controller class`)
+    }
+  }
+}

src/api/controllers/base-controller.ts

@@ -0,0 +1,41 @@
+import BaseController from "@/controllers/base-controller"
+
+import ApplicationDraftsSerializer from "@/serializers/application-drafts-serializer";
+import StudentApplicationDraftsService from "@/services/portal/students/student-application-drafts-service";
+
+export default class StudentApplicationDraftsController extends BaseController {
+  listStudentApplicationDrafts() {
+    const studentId = parseInt(this.params.studentId)
+
+    const applicationService = new StudentApplicationDraftsService({ studentId })
+    return applicationService
+      .getApplicationDrafts()
+      .then((applicationDrafts) => {
+        const applicationDraftsSerializer = new ApplicationDraftsSerializer(applicationDrafts);
+        const data = applicationDraftsSerializer.asListView()
+        this.response.json({ data })
+      })
+      .catch((error: { message: string }) => {
+        this.response.status(404).json({ error: error.message })
+      })
+  }
+
+  getStudentApplicationDraft() {
+    const studentId = parseInt(this.params.studentId)
+    const applicationDraftId = parseInt(this.params.applicationDraftId)
+
+    const applicationService = new StudentApplicationDraftsService({ studentId, applicationDraftId })
+    return applicationService
+      .getApplicationDraft()
+      .then((applicationDraft) => {
+        const applicationDraftsSerializer = new ApplicationDraftsSerializer(applicationDraft);
+        const data = applicationDraftsSerializer.asDetailedView()
+        this.response.json({ data })
+      })
+      .catch((error: { message: string }) => {
+        this.response.status(404).json({ error: error.message })
+      })
+  }
+
+  #getStudent(studentId: number) {}
+}

src/api/controllers/helpers.ts

@@ -0,0 +1,41 @@
+import BaseController from "@/controllers/base-controller"
+
+import ApplicationsSerializer from "@/serializers/applications-serializer"
+import StudentApplicationsService from "@/services/portal/students/student-applications-service"
+
+export default class StudentApplicationsController extends BaseController {
+  listStudentApplications() {
+    const studentId = parseInt(this.params.studentId)
+
+    const applicationService = new StudentApplicationsService({ studentId })
+    return applicationService
+      .getApplications()
+      .then((applications) => {
+        const applicationSerializer = new ApplicationsSerializer(applications)
+        const data = applicationSerializer.asListView()
+        this.response.json({ data })
+      })
+      .catch((error: { message: string }) => {
+        this.response.status(404).json({ error: error.message })
+      })
+  }
+
+  getStudentApplication() {
+    const studentId = parseInt(this.params.studentId)
+    const applicationId = parseInt(this.params.applicationId)
+
+    const applicationService = new StudentApplicationsService({ studentId, applicationId })
+    return applicationService
+      .getApplication()
+      .then((application) => {
+        const applicationSerializer = new ApplicationsSerializer(application)
+        const data = applicationSerializer.asDetailedView()
+        this.response.json({ data })
+      })
+      .catch((error: { message: string }) => {
+        this.response.status(404).json({ error: error.message })
+      })
+  }
+
+  #getStudent(studentId: number) {}
+}

src/api/controllers/portal/students/student-application-drafts-controller.ts

@@ -0,0 +1,22 @@
+// LEGACY: required until deleted from dbo.knex_migrations table production, after wich point they can be removed
+import { Knex } from "knex";
+
+exports.up = async function (knex: Knex) {
+  await knex.schema.alterTable("sfa.msfaa", (t) => {
+    t.specificType("rec_create_date", "DATETIME2(0)")
+      .defaultTo(knex.raw("GETDATE()"), { constraintName: "msfaa_rec_create_date_default" })
+      .notNullable();
+    t.specificType("rec_last_mod_date", "DATETIME2(0)").nullable();
+  });
+
+  return knex.raw(`UPDATE sfa.msfaa SET rec_create_date = o.rec_create_date, rec_last_mod_date = o.rec_last_mod_date
+  FROM sfa.msfaa n, SFAADMIN.MSFAA o
+  WHERE n.id = o.msfaa_id`);
+};
+
+exports.down = async function (knex: Knex) {
+  return knex.schema.alterTable("sfa.msfaa", (t) => {
+    t.dropColumn("rec_create_date");
+    t.dropColumn("rec_last_mod_date");
+  });
+};

src/api/controllers/portal/students/student-applications-controller.ts

@@ -0,0 +1,31 @@
+// TODO: question whether this should be in the database at all.
+// And if so, why is it its own table?
+enum AddressTypes {
+  HOME = 1,
+  MAILING = 2,
+  SCHOOL = 3,
+  PARENT = 4,
+}
+
+export default class AddressType {
+  id: number
+  description: string
+  isActive: boolean
+
+  constructor({
+    id,
+    description,
+    isActive,
+  }: {
+    id: number
+    description: string
+    isActive: boolean
+  }) {
+    this.id = id
+    this.description = description
+    this.isActive = isActive
+  }
+
+  // not in database
+  static readonly Types = AddressTypes
+}

src/api/data/migrations/005_msfaa_missing_fields.ts

@@ -0,0 +1,11 @@
+export default interface ApplicationDraft {
+  id: number
+  studentId: number
+  academicYearId: number
+  createDate: Date
+  updateDate: Date
+  isActive?: boolean
+  applicationJson: string
+  submitDate?: Date
+  status?: string
+}