Refactor: makes session management a bit more readable #304

lanterno · 2023-08-17T14:28:34Z

(Skip first two commits, they have already been merged in another PR - rebase avoided for other reasons).

Changes

Rename the session variables to follow camelCase.
Renames other various variables to provide more readability.
Return 401 when a user in unauthenticated, instead of 400.

for n. 3, I only apply that to one endpoint. In a following PR, I want apply this to all other endpoints, but I need to think of a smarter way to unify the behaviour between all endpoints that require authentication.

PascalinDe

looks great :)

The merge-base changed after approval.

pierluca · 2023-08-22T12:25:34Z

Regarding N° 3 and your comment, you might want to look at ExpressJS error handling.
It might be possible to define a set of exceptions and just write a generic error handler based on the exception type: https://expressjs.com/en/guide/error-handling.html

pierluca · 2023-08-22T12:28:45Z

web/frontend/src/index.tsx

+      const response = await fetch(ENDPOINT_PERSONAL_INFO, req);
+      let result;
      try {


Beware ! This is a dangerous change.
The fetch API returns a promise.
awaiting on a Promise can throw an exception if the Promise is rejected.
This needs to be in the try/catch block.

I changed this to put the try/catch around the whole function. What do you think?

web/frontend/src/index.tsx

pierluca · 2023-08-22T12:33:02Z

web/frontend/src/index.tsx

+            authorization: {},
+          };
+        } else {
+          const txt = await response.text();


if the response did not return a 200, doesn't this always throw ?

if it's neither 200 nor 401

what I meant is: isn't response.text() going to throw before your throw new Error(), when there's no HTTP body ? (i.e. no error information other than the HTTP status sent from the backend)

I'm not sure about how the .text() works in the Fetch API, but according to the documentation and the standard it seems it reads the body. Does it succeed on an empty body ?

@pierluca It succeeds. I tested it.

My test: I restarted the backend, and refreshed the UI causing the backend to return 504. the frontend then displayed the intended message.

pierluca · 2023-08-22T12:36:24Z

web/frontend/src/index.tsx

-        if (res.status !== 200) {
-          const txt = await res.text();
-          throw new Error(`unexpected status: ${res.status} - ${txt}`);
+        if (response.status === 200) {


how do you feel about a switch statement ? 😁

I changed it. Looks good 👍

pierluca · 2023-08-22T14:40:45Z

Sonar seems to have a couple of good points

web/frontend/src/index.tsx

pierluca · 2023-08-22T14:43:56Z

web/frontend/src/index.tsx

+    try {
+      fetchData();
+    } catch (e: any) {
+      setContent(<Failed>{e.toString()}</Failed>);


also, be careful. Here you're changing the content of the page, I assume.
You shouldn't do that in an async context without verifying if the component is still loaded or not.
You might want to have a read
https://devtrium.com/posts/async-functions-useeffect

I believe that is correct, but it already existed like this, so I wouldn't want to change it in this PR.

But still I'm gonna take the advice for when I can apply am improvement confidently.

Agreed, I'm just reviewing some of this code for the first time - so I'm pointing out issues as I see them. That doesn't mean I expect all the fixes in the same PR :)

pierluca

There are still a few issues, but nothing specifically belonging in this PR.
I think we can merge :)

The merge-base changed after approval.

lanterno · 2023-08-23T08:58:01Z

@pierluca Github dismissed your review for some reason.

there's multiple ports in the script, so it's better to clarify the type of port this is.

this commit does two things: 1. Renames the session variables to match update on the backend 2. Handles 401 which is now sent by the backend for unauthenticated users

sonarqubecloud · 2023-08-23T14:09:53Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication

lanterno added web frontend web backend labels Aug 17, 2023

lanterno requested a review from PascalinDe August 17, 2023 14:28

lanterno requested a review from a team as a code owner August 17, 2023 14:28

PascalinDe previously approved these changes Aug 17, 2023

View reviewed changes

pierluca reviewed Aug 22, 2023

View reviewed changes

lanterno requested a review from pierluca August 22, 2023 13:28

pierluca reviewed Aug 22, 2023

View reviewed changes

lanterno requested a review from pierluca August 22, 2023 15:28

pierluca previously approved these changes Aug 23, 2023

View reviewed changes

lanterno requested a review from pierluca August 23, 2023 08:57

Ahmed Elghareeb added 9 commits August 23, 2023 16:06

refactor: renames store to sessionStore

6e0b53a

refactor: renames server port to serveOnPort for clarity

a722623

there's multiple ports in the script, so it's better to clarify the type of port this is.

refactor: returns 401 instead of 200 for non authenticated users

021e5a7

refactor: renames session variables to be camelCase

9e58824

refactor: handles 401 error, and new response schema

acb41ca

this commit does two things: 1. Renames the session variables to match update on the backend 2. Handles 401 which is now sent by the backend for unauthenticated users

refactor: moves error handling outside of function

54a6880

refactor: change if-statement to switch case

5131771

refactor: removes break in default case in switch case

a9225ee

refactor: use promise.catch instead of try/catch

01c4478

lanterno force-pushed the refactor/makes-session-management-a-bit-more-readable branch from 2ba4455 to 01c4478 Compare August 23, 2023 14:07

pierluca approved these changes Aug 23, 2023

View reviewed changes

pierluca merged commit 2aa1565 into main Aug 23, 2023

pierluca deleted the refactor/makes-session-management-a-bit-more-readable branch August 23, 2023 14:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor: makes session management a bit more readable #304

Refactor: makes session management a bit more readable #304

lanterno commented Aug 17, 2023 •

edited

Loading

PascalinDe left a comment

pierluca commented Aug 22, 2023 •

edited

Loading

pierluca Aug 22, 2023

lanterno Aug 22, 2023

pierluca Aug 22, 2023

lanterno Aug 22, 2023 •

edited

Loading

pierluca Aug 23, 2023 •

edited

Loading

lanterno Aug 23, 2023

pierluca Aug 22, 2023

lanterno Aug 22, 2023

pierluca commented Aug 22, 2023

pierluca Aug 22, 2023

lanterno Aug 22, 2023

lanterno Aug 22, 2023

pierluca Aug 23, 2023

pierluca left a comment

lanterno commented Aug 23, 2023

sonarqubecloud bot commented Aug 23, 2023

Refactor: makes session management a bit more readable #304

Refactor: makes session management a bit more readable #304

Conversation

lanterno commented Aug 17, 2023 • edited Loading

Changes

PascalinDe left a comment

Choose a reason for hiding this comment

pierluca commented Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lanterno Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

pierluca Aug 23, 2023 • 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

pierluca commented Aug 22, 2023

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

pierluca left a comment

Choose a reason for hiding this comment

lanterno commented Aug 23, 2023

sonarqubecloud bot commented Aug 23, 2023

lanterno commented Aug 17, 2023 •

edited

Loading

pierluca commented Aug 22, 2023 •

edited

Loading

lanterno Aug 22, 2023 •

edited

Loading

pierluca Aug 23, 2023 •

edited

Loading