Refactor: split code into modules by lanterno · Pull Request #343 · dedis/d-voting

lanterno · 2023-09-06T08:09:13Z

Splits the one-file project into different modules for different purposes.

I think this is a good first iteration, and I will keep trying to improve the structure as I go.

You will also see that I refactored the authentication part a little bit as I moved it to a separate module authManager.ts.

I believe all the module names will still evolve in the future, so no need to think about it too much right now.

web/backend/src/controllers/dela.ts

+
+      res
+        .status(500)
+        .send(`failed to proxy request: ${req.method} ${uri} - ${error.message} - ${resp}`);


web/backend/src/controllers/dela.ts

+  // we strip the `/api` part: /api/form/xxx => /form/xxx
+  const uri = process.env.DELA_NODE_URL + xss(req.url.slice(4));
+
+  axios({


web/backend/src/controllers/dela.ts

+
+  console.log('sending payload:', JSON.stringify(payload), 'to', uri);
+
+  axios({


web/backend/src/Server.ts

ineiti · 2023-09-07T11:37:58Z

Regarding the SonarCloud complaints: is this from moved code, or from code you wrote? If it's the latter, it should be fixed. For the former, we'll ask Pierluca to override the block.

lanterno · 2023-09-07T13:47:54Z

Regarding the SonarCloud complaints: is this from moved code, or from code you wrote? If it's the latter, it should be fixed. For the former, we'll ask Pierluca to override the block.

@ineiti All of it from moved code.

ineiti · 2023-09-07T15:27:48Z

Regarding the SonarCloud complaints: is this from moved code, or from code you wrote? If it's the latter, it should be fixed. For the former, we'll ask Pierluca to override the block.

@ineiti All of it from moved code.

@pierluca I propose to override the complaints then.

coveralls · 2023-09-13T17:56:39Z

Pull Request Test Coverage Report for Build 6235084693

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 57.391%

Totals
Change from base Build 6197509007:	0.0%
Covered Lines:	3269
Relevant Lines:	5696

💛 - Coveralls

ineiti · 2023-09-14T08:34:01Z

@lanterno good to go now.

pierluca

A couple minor points, but this is so much better. Thank youuuu !!!

web/backend/src/authManager.ts

web/backend/src/session.ts

web/backend/src/controllers/authentication.ts

web/backend/src/controllers/dela.ts

lanterno · 2023-09-15T11:06:33Z

@pierluca Thanks for the review.. I applied most of your comments. Check them out.. This one, I might not have understood it very well.

pierluca · 2023-09-15T13:37:15Z

I also just checked something, documentation-wise:

https://github.com/expressjs/session

Note Since version 1.5.0, the cookie-parser middleware no longer needs to be used for this module to work. This module now directly reads and writes cookies on req/res. Using cookie-parser may result in issues if the secret is not the same between this module and cookie-parser.

I haven't checked the versions but it's something to keep an eye on.

- no code changes

improves readability

lanterno · 2023-09-19T11:42:25Z

-- update --
Rebased over main

New versions of expressJs don't need this anymore

Notice that the http method was also switches from POST to GET. Yes, that works the same. GET is obviously better for us.

sonarqubecloud · 2023-09-19T16:15:18Z

SonarCloud Quality Gate failed.

0 Bugs
3 Vulnerabilities
2 Security Hotspots
6 Code Smells

0.0% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

lanterno · 2023-09-19T16:19:44Z

@ineiti @pierluca @PascalinDe Can I get another review here please? I think it's ready.

btw @pierluca , regarding your comment:

I also just checked something, documentation-wise:

https://github.com/expressjs/session

Note Since version 1.5.0, the cookie-parser middleware no longer needs to be used for this module to work. This module now directly reads and writes cookies on req/res. Using cookie-parser may result in issues if the secret is not the same between this module and cookie-parser.

I haven't checked the versions but it's something to keep an eye on.

I removed the middleware and it still works! 👍

ineiti

Let's get this in.

PascalinDe

OK for me as well

PascalinDe · 2023-09-20T13:50:19Z

heya, managed to set up integration test environment on this head

I cannot shuffle an election, I get the following error message:

docker-compose-dela-worker-1-1  | 2023-09-20T13:44:50Z INF d-voting/services/shuffle/neff/handler.go:85 > Starting the neff shuffle protocol ...
docker-compose-dela-worker-1-1  | 2023-09-20T13:44:50Z DBG pkg/mod/go.dedis.ch/dela@v0.0.0-20230907131212-0d61b081b4af/core/txn/signed/mod.go:332 > manager synchronized nonce=0
docker-compose-dela-worker-1-1  | 2023-09-20T13:44:51Z INF pkg/mod/go.dedis.ch/dela@v0.0.0-20230907131212-0d61b081b4af/core/ordering/cosipbft/pbft/mod.go:390 > finalize round with leader: 0
docker-compose-dela-worker-1-1  | 2023-09-20T13:44:51Z INF pkg/mod/go.dedis.ch/dela@v0.0.0-20230907131212-0d61b081b4af/core/ordering/cosipbft/mod.go:387 > block event addr=dela-worker-1:2000 index=16 root=d569eee5
docker-compose-dela-worker-1-1  | 2023-09-20T13:44:51Z DBG pkg/mod/go.dedis.ch/dela@v0.0.0-20230907131212-0d61b081b4af/core/ordering/cosipbft/blocksync/default.go:230 > received synchronization message addr=dela-worker-1:2000 index=16
docker-compose-dela-worker-1-1  | 2023-09-20T13:44:51Z WRN pkg/mod/go.dedis.ch/dela@v0.0.0-20230907131212-0d61b081b4af/core/ordering/cosipbft/pbft/mod.go:639 > transaction not accepted addr=dela-worker-1:2000 reason="failed to shuffle ballots: wrong shuffle round: expected round '1', transaction is for round '0'"

but the interface proceeds to the next step (decrypting), which of course fails as well, since the ballots have not been shuffled

I will try to reproduce on the main branch just to make sure although I haven't seen this error before

PascalinDe

on-going integration tests

PascalinDe

the good news is that I can reproduce on the main's head, so it's not this PR that introduced the error

the bad news is that this means we have a regression on the main branch... I'll open a ticket and look into it: #361

pierluca

All lights are green for me !

lanterno added the web backend label Sep 6, 2023

lanterno requested a review from PascalinDe September 6, 2023 08:09

lanterno requested a review from a team as a code owner September 6, 2023 08:09

github-advanced-security bot found potential problems Sep 6, 2023

View reviewed changes

lanterno force-pushed the refactor/moves-auth-code-to-different-module branch from 8c9fabf to f8fa598 Compare September 6, 2023 09:00

PascalinDe reviewed Sep 6, 2023

View reviewed changes

web/backend/src/Server.ts Outdated Show resolved Hide resolved

lanterno requested a review from PascalinDe September 7, 2023 01:01

PascalinDe previously approved these changes Sep 7, 2023

View reviewed changes

ineiti assigned lanterno Sep 13, 2023

lanterno force-pushed the refactor/moves-auth-code-to-different-module branch from 7be6ee6 to 8750939 Compare September 13, 2023 17:53

pierluca reviewed Sep 14, 2023

View reviewed changes

web/backend/src/authManager.ts Outdated Show resolved Hide resolved

web/backend/src/session.ts Show resolved Hide resolved

web/backend/src/controllers/authentication.ts Outdated Show resolved Hide resolved

web/backend/src/controllers/dela.ts Show resolved Hide resolved

ineiti mentioned this pull request Sep 14, 2023

Fixing eslint warnings #354

Merged

lanterno dismissed PascalinDe’s stale review via bed8cf9 September 15, 2023 10:52

lanterno requested a review from pierluca September 15, 2023 11:05

Ahmed Elghareeb added 9 commits September 19, 2023 13:13

refactor: moves authorization code to a separate module

037f1ae

refactor: handles more 401 cases

33ab825

refactor: remove dead code

00064c8

refactor: moves session logic into a separate module

45d0321

refactor: moves authentication APIs to a separate module

fbc5e63

refactor: import newly created custom router

afda4cc

refactor: moves users APIs to a custom module

8ce18c9

- no code changes

refactor: imports newly created custom router for users

b40dcea

refactor: moves proxies APIs to a separate module

a239bd9

Ahmed Elghareeb added 10 commits September 19, 2023 13:13

refactor: imports newly created custom router for proxies

cc8f9ae

refactor: moves dela APIs to a separate module

3fb5695

- no code changes

refactor: imports newly created custom router for dela APIs

20bd25b

refactor: improve URL readability/structure for all routers/routes

50167a3

refactor: moves port listener code to the end of the server

d9d284c

improves readability

refactor: adds newly added modules to typescript monitored files

2ea5504

refactor: fix wrongly capitalized letter

a5f73aa

refactor: moves all session setup to session.ts

2920b8c

refactor: fix function name (follow convention)

74b3780

refactor: splits long line into better format

feaf710

lanterno force-pushed the refactor/moves-auth-code-to-different-module branch from d84b62d to feaf710 Compare September 19, 2023 11:13

Ahmed Elghareeb added 2 commits September 19, 2023 13:43

refactor: removes unneeded expressjs middleware

9c1a3c6

New versions of expressJs don't need this anymore

refactor: switches to more readable url params format

eeb54aa

Notice that the http method was also switches from POST to GET. Yes, that works the same. GET is obviously better for us.

lanterno requested review from PascalinDe and ineiti September 19, 2023 16:18

ineiti approved these changes Sep 20, 2023

View reviewed changes

PascalinDe approved these changes Sep 20, 2023

View reviewed changes

PascalinDe requested changes Sep 20, 2023

View reviewed changes

PascalinDe approved these changes Sep 20, 2023

View reviewed changes

pierluca approved these changes Sep 20, 2023

View reviewed changes

pierluca merged commit ca86384 into main Sep 20, 2023

pierluca deleted the refactor/moves-auth-code-to-different-module branch September 20, 2023 15:44


		console.log('sending payload:', JSON.stringify(payload), 'to', uri);

		axios({

Conversation

lanterno commented Sep 6, 2023

Uh oh!

Check failure

Check warning

Check warning

Uh oh!

ineiti commented Sep 7, 2023

Uh oh!

lanterno commented Sep 7, 2023

Uh oh!

ineiti commented Sep 7, 2023

Uh oh!

coveralls commented Sep 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 6235084693

💛 - Coveralls

Uh oh!

ineiti commented Sep 14, 2023

Uh oh!

pierluca left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lanterno commented Sep 15, 2023

Uh oh!

pierluca commented Sep 15, 2023

Uh oh!

lanterno commented Sep 19, 2023

Uh oh!

sonarqubecloud bot commented Sep 19, 2023

Uh oh!

lanterno commented Sep 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ineiti left a comment

Choose a reason for hiding this comment

Uh oh!

PascalinDe left a comment

Choose a reason for hiding this comment

Uh oh!

PascalinDe commented Sep 20, 2023

Uh oh!

PascalinDe left a comment

Choose a reason for hiding this comment

Uh oh!

PascalinDe left a comment • edited by ineiti Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pierluca left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

coveralls commented Sep 13, 2023 •

edited

Loading

lanterno commented Sep 19, 2023 •

edited

Loading

PascalinDe left a comment •

edited by ineiti

Loading