Add REST Endpoint for DAC Application Approval with Validation and State Management #148

Azher2Ali · 2025-01-13T17:50:38Z

Summary

#117- Introduced a new REST endpoint that allows DAC (Data Access Committee) members to approve applications. This feature ensures robust state transitions, clear validations, and comprehensive user feedback.

Description of Changes

API

New Endpoint: POST /applications/{applicationId}/approve
- Allows DAC to approve applications one at a time.
- Validates applicationId and approverId as required fields and ensures they are numbers.
- Updates the state of an application to approved and integrates with the state transition machine.
- Prevents modifications to approved applications by any user.
Response:
- Provides clear feedback on success or failure of approval.
- Uses structured error handling with proper HTTP status codes and descriptive messages.
Swagger Documentation:
- Added comprehensive instructions for using the endpoint, including request/response formats and validation criteria.

Service

Refined logic to handle state transitions robustly.
Ensures the service prevents type-related errors and edge cases during the approval process.
Updates application history to include:
- Timestamp of approval.
- Information about the approver.

Data Model

Added support for storing approval metadata, including the approver’s details and approval timestamp.

Special Instructions

Before running these changes:

Ensure all dependencies are up-to-date by running:
```
pnpm i
```

…ate Management

apps/api/src/resources/swagger.yaml

packages/data-model/src/types.ts

demariadaniel · 2025-01-14T20:18:14Z

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

+		});
+		return;
+	  }
+


Do you have the Prettier extension installed? There are whitespace changes here which don't match what I'd expect to see

Missed adding Prettier under my extention list, will surely keep in mind for the next time. Thanks for noticing!

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

demariadaniel · 2025-01-14T20:38:14Z

apps/api/src/service/ApplicationStateMachine.ts

@@ -0,0 +1,23 @@
+import {  ApplicationStates, ApplicationStateValues } from "@pcgl-daco/data-model/src/types.js";


a) new files need the Copyright at the top
b) We have ApplicationStateManager defined at https://github.com/Pan-Canadian-Genome-Library/daco/blob/main/apps/api/src/api/states.ts#L61
which extends functionality https://github.com/eram/typescript-fsm

including the .can method which could essentially perform the same function as this.
I would use the existing class and work within that framework.

Now, there may not be implementation examples for the State Machine yet in the API, except for in the unit tests: https://github.com/Pan-Canadian-Genome-Library/daco/blob/main/apps/api/tests/api/application-state.test.ts

So I can review this with you and show how Jon and I were intending to implement the state machine and action updates

demariadaniel

Off to a great start, handful of changes to iron out first

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

demariadaniel · 2025-01-17T21:23:28Z

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

-  applicationId,
-  approverId,
+	applicationId,
+	approverId,


approverId is unused here

demariadaniel · 2025-01-17T21:25:03Z

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

+				success: false,
+				message: 'Application not found.',
+				errors: 'ApplicationNotFound',
+			};


This can just be (!result.success) { return result }
The success, errors and message will already be populated by getApplicationById

Add REST Endpoint for DAC Application Approval with Validation and St…

24b0700

…ate Management

Azher2Ali added New Feature API labels Jan 13, 2025

Azher2Ali requested a review from demariadaniel January 14, 2025 14:44

Azher2Ali linked an issue Jan 14, 2025 that may be closed by this pull request

Endpoint to Allow DAC Approve #117

Open

Adding changes to swagger docs

89226d1