✏️ Feat/ #22 Application Update methods

apps/api/src/api/application-api.ts

@@ -18,10 +18,10 @@
  */
 
 import { ApplicationStates } from '@pcgl-daco/data-model/src/types.js';
+import { getDbInstance } from '../db/index.js';
 import applicationService from '../service/application-service.js';
 import { type ApplicationContentUpdates, type ApplicationService } from '../service/types.js';
-
-import { getDbInstance } from '../db/index.js';
+import { failure } from '../utils/results.js';
 
 export const editApplication = async ({ id, update }: { id: number; update: ApplicationContentUpdates }) => {
 	const database = getDbInstance();
@@ -30,7 +30,9 @@ export const editApplication = async ({ id, update }: { id: number; update: Appl
 	const applicationRecord = await service.getApplicationById({ id });
 
 	if (!applicationRecord) {
-		throw new Error('Application Not Found');
+		const message = `Application Not Found with ${id}`;
+		console.error(message);
+		return failure(message);
 	}
 
 	// Validate Application state will allow updates
@@ -44,15 +46,11 @@ export const editApplication = async ({ id, update }: { id: number; update: Appl
 		state === ApplicationStates.DAC_REVIEW;
 
 	if (isEditState) {
-		const updatedRecord = service.editApplication({ id, update });
-		if (updatedRecord) {
-			return updatedRecord;
-		} else {
-			console.error(`Error updating application`);
-			return null;
-		}
+		const result = await service.editApplication({ id, update });
+		return result;
 	} else {
-		console.error(`Cannot update application with state ${state}`);
-		return null;
+		const message = `Cannot update application with state ${state}`;
+		console.error(message);
+		return failure(message);
 	}
 };

apps/api/src/routes/application-router.ts

@@ -23,15 +23,15 @@ import { editApplication } from '../api/application-api.js';
 const applicationRouter = express.Router();
 
 applicationRouter.post('/application/edit/', async (req, res) => {
-	// TODO: Add Auth, Zod, & success/failure types
+	// TODO: Add Auth & Zod validation
 	const data = req.body;
 	const { id, update } = data;
-	const record = await editApplication({ id, update });
+	const result = await editApplication({ id, update });
 
-	if (record) {
-		res.send(record);
+	if (result.success) {
+		res.send(result.data);
 	} else {
-		res.status(500).send({ error: `Error updating application with id ${id}` });
+		res.status(500).send({ message: result.message, errors: result.errors });
 	}
 });
 

apps/api/src/service/application-service.ts

@@ -22,6 +22,7 @@ import { and, eq, sql } from 'drizzle-orm';
 import { type PostgresDb } from '../db/index.js';
 import { applicationContents } from '../db/schemas/applicationContents.js';
 import { applications } from '../db/schemas/applications.js';
+import { failure, success } from '../utils/results.js';
 import {
 	type ApplicationContentUpdates,
 	type ApplicationsColumnName,
@@ -30,8 +31,6 @@ import {
 } from './types.js';
 import { sortQuery } from './utils.js';
 
-export type ApplicationService = ReturnType<typeof applicationService>;
-
 const applicationService = (db: PostgresDb) => ({
 	createApplication: async ({ user_id }: { user_id: string }) => {
 		const newApplication: typeof applications.$inferInsert = {
@@ -95,11 +94,12 @@ const applicationService = (db: PostgresDb) => ({
 				contents: editedContents[0],
 			};
 
-			return application;
+			return success(application);
 		} catch (err) {
-			console.error(`Error at editApplication with id: ${id}`);
+			const message = `Error at editApplication with id: ${id}`;
+			console.error(message);
 			console.error(err);
-			return null;
+			return failure(message, err);
 		}
 	},
 	findOneAndUpdate: async ({ id, update }: { id: number; update: ApplicationUpdates }) => {
@@ -124,6 +124,7 @@ const applicationService = (db: PostgresDb) => ({
 				.from(applications)
 				.where(eq(applications.id, id))
 				.leftJoin(applicationContents, eq(applications.contents, applicationContents.id));
+
 			if (!applicationRecord[0]) throw new Error('Application record is undefined');
 
 			const application = {
@@ -135,6 +136,7 @@ const applicationService = (db: PostgresDb) => ({
 		} catch (err) {
 			console.error(`Error at getApplicationById with id: ${id}`);
 			console.error(err);
+
 			return null;
 		}
 	},

apps/api/src/utils/results.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2024 The Ontario Institute for Cancer Research. All rights reserved
+ *
+ * This program and the accompanying materials are made available under the terms of
+ * the GNU Affero General Public License v3.0. You should have received a copy of the
+ * GNU Affero General Public License along with this program.
+ *  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+ * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+ * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+// types
+export type Success<T> = { success: true; data: T };
+export type Failure = { success: false; message: string; errors?: any };
+export type Result<T> = Success<T> | Failure;
+export type AsyncResult<T> = Promise<Result<T>>;
+
+// helpers
+export const success = <T>(data: T): Success<T> => ({ success: true, data });
+export const failure = (message: string, errors?: any): Failure => ({
+	success: false,
+	message,
+	errors,
+});

apps/api/tests/api/application-api.test.ts

@@ -66,9 +66,9 @@ describe('Application API', () => {
 			await applicationService.findOneAndUpdate({ id, update: stateUpdate });
 
 			const contentUpdate = { applicant_title: 'Dr.' };
-			const editedApplication = await editApplication({ id, update: contentUpdate });
+			const result = await editApplication({ id, update: contentUpdate });
 
-			assert.ok(!editedApplication);
+			assert.ok(!result.success);
 		});
 
 		after(() => {});

apps/api/tests/services/application-service.test.ts

@@ -251,10 +251,14 @@ describe('Application Service', () => {
 
 			const update = { applicant_first_name: 'Test' };
 
-			const editedApplication = await applicationService.editApplication({ id, update });
+			const result = await applicationService.editApplication({ id, update });
 
-			assert.ok(editedApplication && editedApplication.contents);
+			assert.ok(result.success);
+
+			const editedApplication = result.data;
 			assert.strictEqual(editedApplication.state, ApplicationStates.DRAFT);
+
+			assert.ok(editedApplication.contents);
 			assert.strictEqual(editedApplication.contents.applicant_first_name, update.applicant_first_name);
 		});
 
@@ -274,11 +278,14 @@ describe('Application Service', () => {
 			assert.strictEqual(reviewRecord[0].state, ApplicationStates.INSTITUTIONAL_REP_REVIEW);
 
 			const contentUpdate = { applicant_last_name: 'User' };
-			const editedApplication = await applicationService.editApplication({ id, update: contentUpdate });
+			const result = await applicationService.editApplication({ id, update: contentUpdate });
+			assert.ok(result.success);
 
-			assert.ok(editedApplication && editedApplication.contents);
+			const editedApplication = result.data;
 			assert.strictEqual(editedApplication.id, id);
 			assert.strictEqual(editedApplication.state, ApplicationStates.DRAFT);
+
+			assert.ok(editedApplication.contents);
 			assert.strictEqual(editedApplication.contents.applicant_last_name, contentUpdate.applicant_last_name);
 		});
 	});