Vps 25/resource api definitions are implemented #216

jacobmathew105 · 2024-08-12T04:08:01Z

Describe the issue

Resources is a new feature that allows users to access various medical resources. Without API endpoints, users are unable to create, retrieve, update, or delete resources, limiting the functionality of the feature. Once the API endpoints are implemented, users can start using them when designing the resources feature.

Describe the solution

This feature enables users to interact with various medical resources by adding the following API endpoints

Create a New Resource: POST /resources
Retrieve a Specific Resource: GET /resources/:resourceId
Update a Resource: PUT /resources/:resourceId
Delete a Resource: DELETE /resources/:resourceId
Retrieve All Visible Resources: GET /group/:groupId/resources/
Add a Flag to a Group: POST /group/:groupId/flag

Risk

A potential risk is the new feature may introduce new bugs.

Definition of Done

Code peer-reviewed
Wiki Documentation is written and up to date
Unit tests written and passing
Integration tests written and passing
Continuous Integration build passing
Acceptance criteria met
Deployed to production environment

Reviewed By

Who reviewed your PR - for commit history once merged

… resource

…leting a resource and authentication

feat: added endpoint to retrieve all resources of a group feat: created resource DAO, added functions for api calls

…ented

button to test api for resources

without auth

…ps://github.com/UoaWDCC/VPS into VPS-25/Resource-API-Definitions-are-implemented

chore: fixed types and bugs in resource APIs

codecreator127

lgtm

wjin-lee

Great job - looking sweet.
Few nits, after should be good to merge.

backend/src/routes/api/resources.js

choden-dev · 2024-08-14T08:06:41Z

backend/src/routes/api/resources.js

+  } catch (error) {
+    return res.status(HTTP_FORBIDDEN).send("Forbidden");
+  }


nit: this is not actually true?

https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403

indicates that the server understood the request but refused to process it

(4xx suggests that there was something that went wrong because of the request made)

We should have a list of 5xx codes as well - which is the correct response when something goes wrong on "our" side.

I'd say that this is a 5xx error if we catch

internal server error

choden-dev · 2024-08-15T07:58:53Z

backend/src/db/daos/resourcesDao.js

+const getResourceById = async (resourceId) => {
+  const resource = await Resource.findById(resourceId);
+  return resource;
+};
+
+const deleteResourceById = async (resourceId) => {
+  const resource = await Resource.findById(resourceId);
+  await Resource.findByIdAndRemove(resourceId);
+  return resource;
+};
+
+const getAllVisibleResources = async (groupId) => {
+  const group = await Group.findById(groupId);
+  const allResources = await Resource.find({});
+  const flags = group.currentFlags;
+
+  // Filter resources based on the comparison
+  const visibleResources = allResources.filter((resource) =>
+    resource.requiredFlags.every((flag) => flags.includes(flag))
+  );
+
+  return visibleResources;
+};
+
+const addFlag = async (groupId, flag) => {
+  const group = await Group.findById(groupId);
+  if (!group.currentFlags.includes(flag)) {
+    group.currentFlags.push(flag);
+    await group.save();
+  }
+  return group.currentFlags;
+};
+
+const removeFlag = async (groupId, flag) => {
+  const group = await Group.findById(groupId);
+
+  if (group.currentFlags.includes(flag)) {
+    const index = group.currentFlags.indexOf(flag);
+    group.currentFlags.splice(index, 1);
+    await group.save();
+  }
+
+  return group.currentFlags;
+};


its just me, but do we agree using no typescript without at least documenting functions with JSDoc leads to many problems down the line? After talking to @wjin-lee code quality is now whatever in VPS but I'd imagine doing so would assist in meeting the required milestone.

At least a @param and @returns would help immensely for whoever next consumes these functions

something simple could be:

/** * @param {string} groupId - The unique identifier of the group. * @param {string} flag - The flag to be removed from the group's current flags. * @returns {Promise<string[]>} A promise that resolves to the updated list of current flags for the group. * * @example * const updatedFlags = await removeFlag('12345', 'active'); * console.log(updatedFlags); // Output: ['inactive', 'pending'] */

this way someone can hover over the function to see what its doing rather needing to go to the definition

obviously a nit tho 💀

mmm - I might start enforcing this from now - we can discuss more in the next sprint meeting!

choden-dev · 2024-08-16T09:53:13Z

backend/src/routes/api/resources.js

@@ -24,7 +24,15 @@ const HTTP_INTERNAL_SERVER_ERROR = 500;
 // Apply auth middleware to all routes below this point
 router.use(auth);

-// Create a New Resource
+/**


nice catch on the 5xx

Changes fixed

wjin-lee

lgtm!

wjin-lee · 2024-08-19T04:06:50Z

backend/src/db/daos/resourcesDao.js

+const getResourceById = async (resourceId) => {
+  const resource = await Resource.findById(resourceId);
+  return resource;
+};
+
+const deleteResourceById = async (resourceId) => {
+  const resource = await Resource.findById(resourceId);
+  await Resource.findByIdAndRemove(resourceId);
+  return resource;
+};
+
+const getAllVisibleResources = async (groupId) => {
+  const group = await Group.findById(groupId);
+  const allResources = await Resource.find({});
+  const flags = group.currentFlags;
+
+  // Filter resources based on the comparison
+  const visibleResources = allResources.filter((resource) =>
+    resource.requiredFlags.every((flag) => flags.includes(flag))
+  );
+
+  return visibleResources;
+};
+
+const addFlag = async (groupId, flag) => {
+  const group = await Group.findById(groupId);
+  if (!group.currentFlags.includes(flag)) {
+    group.currentFlags.push(flag);
+    await group.save();
+  }
+  return group.currentFlags;
+};
+
+const removeFlag = async (groupId, flag) => {
+  const group = await Group.findById(groupId);
+
+  if (group.currentFlags.includes(flag)) {
+    const index = group.currentFlags.indexOf(flag);
+    group.currentFlags.splice(index, 1);
+    await group.save();
+  }
+
+  return group.currentFlags;
+};


mmm - I might start enforcing this from now - we can discuss more in the next sprint meeting!

wjin-lee · 2024-08-19T04:07:10Z

backend/src/routes/api/resources.js

@@ -24,7 +24,15 @@ const HTTP_INTERNAL_SERVER_ERROR = 500;
 // Apply auth middleware to all routes below this point
 router.use(auth);

-// Create a New Resource
+/**


nice catch on the 5xx

jacobmathew105 and others added 13 commits August 3, 2024 15:20

[VPS-25] feat: created resource page and implemented API for creating…

364bd3b

… resource

[VPS-25] feat: implemented retrieving a specific/visible resource, de…

ad08938

…leting a resource and authentication

[VPS-25] feat: added in the authentication routing

802e3b7

feat: added flag endpoints to add and remove

e3cf6e0

feat: added endpoint to retrieve all resources of a group feat: created resource DAO, added functions for api calls

Merge branch 'master' into VPS-25/Resource-API-Definitions-are-implem…

481bc28

…ented

feat: added DAOs for adding and removing flags

d167368

fix: added resources to router, added a frontend

020e253

button to test api for resources

fix: fixed all the resourceDaos and tested them

c4a7c02

without auth

chore: removed button on frontend for testing apis

0b5f8bb

feat: added the api to update a resource

1df8c93

Merge branch 'VPS-25/Resource-API-Definitions-are-implemented' of htt…

bfac761

…ps://github.com/UoaWDCC/VPS into VPS-25/Resource-API-Definitions-are-implemented

chore: removed duplicate resources api

6f0e45e

feat: added dao for updating a resource

ac49a79

chore: fixed types and bugs in resource APIs

jacobmathew105 requested review from wjin-lee, codecreator127 and JordanBlenn August 12, 2024 04:08

codecreator127 added 2 commits August 12, 2024 16:32

chore: ran prettier

13e7d32

chore: fixed linter issues

f1166c9

codecreator127 reviewed Aug 12, 2024

View reviewed changes

codecreator127 approved these changes Aug 12, 2024

View reviewed changes

wjin-lee previously requested changes Aug 13, 2024

View reviewed changes

backend/src/routes/api/resources.js Outdated Show resolved Hide resolved

backend/src/routes/api/resources.js Outdated Show resolved Hide resolved

chore: removed unused import

d7ca066

choden-dev reviewed Aug 14, 2024

View reviewed changes

fix: added error handling and changed forbidden to

b411752

internal server error

codecreator127 requested a review from wjin-lee August 15, 2024 04:00

choden-dev approved these changes Aug 15, 2024

View reviewed changes

chore: added jsdocs to resources APIs

dfae757

choden-dev reviewed Aug 16, 2024

View reviewed changes

wjin-lee approved these changes Aug 19, 2024

View reviewed changes

codecreator127 merged commit 8a6af67 into master Aug 19, 2024
6 checks passed

JordanBlenn deleted the VPS-25/Resource-API-Definitions-are-implemented branch August 30, 2024 01:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vps 25/resource api definitions are implemented #216

Vps 25/resource api definitions are implemented #216

jacobmathew105 commented Aug 12, 2024 •

edited by codecreator127

Loading

codecreator127 left a comment

wjin-lee left a comment

choden-dev Aug 14, 2024

choden-dev Aug 15, 2024 •

edited

Loading

choden-dev Aug 15, 2024

choden-dev Aug 15, 2024

wjin-lee Aug 19, 2024

choden-dev Aug 16, 2024

wjin-lee Aug 19, 2024

wjin-lee left a comment

wjin-lee Aug 19, 2024

wjin-lee Aug 19, 2024

Vps 25/resource api definitions are implemented #216

Vps 25/resource api definitions are implemented #216

Conversation

jacobmathew105 commented Aug 12, 2024 • edited by codecreator127 Loading

Describe the issue

Describe the solution

Risk

Definition of Done

Reviewed By

codecreator127 left a comment

Choose a reason for hiding this comment

wjin-lee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

choden-dev Aug 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wjin-lee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacobmathew105 commented Aug 12, 2024 •

edited by codecreator127

Loading

choden-dev Aug 15, 2024 •

edited

Loading