#37652856-Backend api implementation of project CRUD #20

tanerochris · 2020-05-15T01:37:24Z

Description

Developing the API backend for creating, updating and viewing of projects on voxnostra,
 ### How Has This Been Tested?
Tests have been written for the different endpoints

Any background context you want to provide?

 ### Relevant Task link (from the project board) 
Card 37652856

Questions

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented on my code, particularly in hard-to-understand areas
I have added necessary inline code documentation
I have added tests that prove my fix is effective and that this feature works
New and existing unit tests pass locally with my changes
closes Backend API implementation of Project CRUD #14

…operties file

… constant init

… folder

OpenAPI 3.0 design Yaml and JSON files closes #6

- set content type for catchall error response

- workaround for JS Object destructuring inside an if block considered error by codacity

Added instructions to run API endpoint documentation Added link to external docs close

- Updated readme file - Added schemas and model related to project feature - Created an all model file to import into database ,prevents previous error from mongoose "cannot overrite model already compiled" - Added ApiErrorResponse class to manage api errors - Wrote tests for Project feature endpoints - Updated setupTests.js with code to run before and after test suits run - rename auth directory to user to match docs api endpoints close #14

- added jest options --forceExit --detectOpenHandles --maxWorkers=10 to exit jest when all test pass close #14

- fix codacy fail error close #14

cliffordten · 2020-05-15T18:56:40Z

Hey @tanerochris Please could you attach screenshot for test on different endpoints?

tanerochris · 2020-05-16T11:20:10Z

Hello you can clone the branch and run the test. yarn test or npm test

…

On Fri, May 15, 2020, 19:56 Teneng Clifford ***@***.***> wrote: Hey @tanerochris <https://github.com/tanerochris> Please could you attach screenshot for test on different endpoints? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#20 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACC3JXKVWUTHWCWLQDN34ELRRWF7LANCNFSM4NBFPPPQ> .

- documented project api endpoints - refactored project structure, renamed folders and moved files raised in #16 - added prettier configuration partially resolve #14 reviews

KaiserPhemi

Critical

File Naming: Going forward let's adopt camelCase for naming files as opposed to snake-case that's been used.
It appears responses aren't sent for error messages thrown.
I noticed we're using res.json() & having to set the header. res.send() automatically sets the header so it's preferable.
I might need to schedule a sync with all today(21st May) on this .

KaiserPhemi · 2020-05-21T01:33:20Z

pages/api/user/sign-out.js

+ * @returns {Promise<void>}
+ */
+async function SignOutHandler({ req, res }) {
+  if (req.method === 'DELETE') {


Nitpick

If this route is meant to specifically handle sign-out (cos the frontend should specifically send delete request in the first place) why check the http method in the first place? Besides I believe all checking/validation should be handle by a middleware.

@mernxl could you look into this.

KaiserPhemi · 2020-05-21T01:38:31Z

pages/api/user/sign-up.js

+ * @returns {Promise<void>}
+ */
+async function SignUpHandler({ req, res }) {
+  if (req.method === 'POST') {


Nitpick

Same thing as the comment I left above.

KaiserPhemi · 2020-05-21T02:16:41Z

pages/api/projects/index.js

+ */
+const IndexProjectHandler = async ({ req, res }) => {
+  if (req.method === 'GET') {
+    const limit = req.query.limit || 0;


Nitpick

A better approach would be to abstract these into a helper file or a middleware

tanerochris · 2020-05-21T12:17:28Z

@KaiserPhemi I will love to mention that we are using NextJS for the project ,it is an opinionated framework so there are some aspects of the file structure and naming convention that is dictated by the framework. Equally handling API requests.

…

On Thu, May 21, 2020, 03:46 Oluwafemi Akinwa ***@***.***> wrote: ***@***.**** requested changes on this pull request. Critical - File Naming: Going forward let's adopt camelCase for naming files as opposed to snake-case that's been used. - It appears responses aren't sent for error messages thrown. - I noticed we're using res.json() & having to set the header. res.send() automatically sets the header so it's preferable. - I might need to schedule a sync with all today(21st May) on this . ------------------------------ In pages/api/user/sign-out.js <#20 (comment)>: > @@ -0,0 +1,19 @@ +import Middleware from '../../../middlewares'; +/** + * Sets the session value to null. + * + * DELETE endpoint + * @param req + * @param res + * @returns {Promise<void>} + */ +async function SignOutHandler({ req, res }) { + if (req.method === 'DELETE') { Nitpick If this route is meant to specifically handle sign-out (cos the frontend should specifically send delete request in the first place) why check the http method in the first place? Besides I believe all checking/validation should be handle by a middleware. ------------------------------ In pages/api/user/sign-up.js <#20 (comment)>: > +import { setUserSession } from '../../../helpers/auth-helpers'; +import Middleware from '../../../middlewares'; +import User from '../../../models/user/user.model'; + +/** + * POST only + * Sign up a user, body must contain these two fields + * + * @param req + * @param req.body.email + * @param req.body.password + * @param res + * @returns {Promise<void>} + */ +async function SignUpHandler({ req, res }) { + if (req.method === 'POST') { Nitpick Same thing as the comment I left above. ------------------------------ In pages/api/projects/index.js <#20 (comment)>: > @@ -0,0 +1,40 @@ +import mongoose from 'mongoose'; +import Middleware from '../../../middlewares'; + +const Project = mongoose.model('Project'); +/** + * @async + * @desc Api handles project list and search request + * @param {{ req: NextApiRequest, res: NextApiResponse }} prop + */ +const IndexProjectHandler = async ({ req, res }) => { + if (req.method === 'GET') { + const limit = req.query.limit || 0; Nitpick A better approach would be to abstract these into a helper file or a middleware — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#20 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACC3JXNQTJJ5TXQGOWR4VLLRSSIY5ANCNFSM4NBFPPPQ> .

mernxl and others added 18 commits May 9, 2020 17:23

feat: add api error classes, implement catch all handlers in middlewares

66a529f

feat(middlewares): add json method to res object

1bb8812

chore(deps): add bcrypt, jsonwebtoken, and moment packages

524562c

chore(props): add Authentication dependent properties to voxnostra.pr…

008d9d3

…operties file

feat(libs): add authentication helpers, configure constants

afe58dd

fix(libs): fix db initialisation logic

7587c2b

fix(libs): fix session setup logic

327bd2d

refactor(middleware): add console.error logging for caught error

bfd1646

feat(libs): add setUserSession function to auth-helpers, fix config…

6c7db9f

… constant init

feat(schema): add password embedded schema, move user.model into user…

4f7c4fe

… folder

feat(api): add user-authentication api endpoints

52a4a5b

7-feat(api): swap testapi endpoint with a health-check endpoint

97235b5

6-docs(): Api design documentation

9c65046

OpenAPI 3.0 design Yaml and JSON files closes #6

7-feat(schema): add email validation regex with onFail message

6cba8cb

7-fix(middleware): fix sending 404 after response sent

a8ffd85

- set content type for catchall error response

7-fix(api): fix res.session is undefined for reset-password

807a19e

- workaround for JS Object destructuring inside an if block considered error by codacity

6-docs(enpoints): updated API docs readme

645f4f3

Added instructions to run API endpoint documentation Added link to external docs close

Merge branch 'ft/7-user-authentication' into ft/14-backend-project-crud

35858a0

tanerochris added the enhancement New feature or request label May 15, 2020

tanerochris added this to the sprint-2 milestone May 15, 2020

tanerochris requested review from mernxl, dherve19 and cliffordten May 15, 2020 01:37

tanerochris changed the title ~~37652856-Backend api implementation of project CRUD~~ #37652856-Backend api implementation of project CRUD May 15, 2020

tanerochris added 5 commits May 14, 2020 21:49

14-feat(backend): Project CRUD API implementation

fb8c73e

- added jest options --forceExit --detectOpenHandles --maxWorkers=10 to exit jest when all test pass close #14

14-fix(backend): Project CRUD API implementation

c27d063

- fix codacy fail error close #14

14-fix(backend): Project CRUD API implementation

8e5d6a4

- fix codacy fail error close #14

This was referenced May 17, 2020

#7-User Authentication #16

Open

Create Mongo DB Schemas #4

Closed

tanerochris requested review from KaiserPhemi and removed request for dherve19 May 20, 2020 12:01

tanerochris added 3 commits May 20, 2020 06:46

14-refactor(structure): Rename folders and moved files

ee8d6f4

- documented project api endpoints - refactored project structure, renamed folders and moved files raised in #16 - added prettier configuration partially resolve #14 reviews

14-refactor(structure): Rename folders and moved files

49ec08f

- documented project api endpoints - refactored project structure, renamed folders and moved files raised in #16 - added prettier configuration partially resolve #14 reviews

14-refactor(structure): Rename folders and moved files

9f2eda4

- documented project api endpoints - refactored project structure, renamed folders and moved files raised in #16 - added prettier configuration partially resolve #14 reviews

KaiserPhemi suggested changes May 21, 2020

View reviewed changes

This was referenced May 29, 2020

Link backend and frontend #23

Open

Ft/23 link backend frontend #24

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#37652856-Backend api implementation of project CRUD #20

#37652856-Backend api implementation of project CRUD #20

tanerochris commented May 15, 2020

cliffordten commented May 15, 2020

tanerochris commented May 16, 2020 via email

KaiserPhemi left a comment

KaiserPhemi May 21, 2020

tanerochris May 26, 2020

KaiserPhemi May 21, 2020

KaiserPhemi May 21, 2020

tanerochris commented May 21, 2020 via email

#37652856-Backend api implementation of project CRUD #20

Are you sure you want to change the base?

#37652856-Backend api implementation of project CRUD #20

Conversation

tanerochris commented May 15, 2020

Description

Any background context you want to provide?

Questions

cliffordten commented May 15, 2020

tanerochris commented May 16, 2020 via email

KaiserPhemi left a comment

Choose a reason for hiding this comment

Critical

KaiserPhemi May 21, 2020

Choose a reason for hiding this comment

Nitpick

tanerochris May 26, 2020

Choose a reason for hiding this comment

KaiserPhemi May 21, 2020

Choose a reason for hiding this comment

Nitpick

KaiserPhemi May 21, 2020

Choose a reason for hiding this comment

Nitpick

tanerochris commented May 21, 2020 via email