Node revamp: Controllers Lesson #27695

fcasibu · 2024-03-26T19:29:42Z

Because

To add a new lesson about Controllers in the MVC pattern for the node revamp

This PR

Adds new lesson to nodeJS/express/controllers.md

Issue

Closes #27615

Additional Information

Pull Request Requirements

I have thoroughly read and understand The Odin Project Contributing Guide
The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
The Because section summarizes the reason for this PR
The This PR section has a bullet point list describing the changes in this PR
If this PR addresses an open issue, it is linked in the Issue section
If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
If any lesson files are included in this PR, they follow the Layout Style Guide

…status

…middleware arguments

MaoShizhong

Mainly wording/formatting suggestions. It's a big lesson and I've not quite got the time to dive deeper into the rest of it, but will aim to do so at a later point.

nodeJS/express/controllers.md

Co-authored-by: MaoShizhong <122839503+MaoShizhong@users.noreply.github.com>

fcasibu · 2024-04-02T02:36:30Z

Thanks @MaoShizhong I appreciate it!

MaoShizhong

Again, mainly nits and suggestions.

Content-wise, fabulous lesson 🤌

Some general things that likely should be changed throughout the file:

End list items with a period to match most other lessons.
Capitalise Express, as opposed to express.
Change "middleware"/"middlewares" to "middleware function" and "middleware functions" respectively, to follow the terminology used by Express itself. The few times Express use "middleware" without "function(s)" after it, it's referring to the general concept of middleware. For example, "application-level middleware" (referring the the middleware functions that are application-level as a whole" or "types of middleware", again being a more "conceptual" use of the word. Whenever it refers to actual functions, it uses "middleware function".

nodeJS/express/controllers.md

MaoShizhong · 2024-04-04T05:29:53Z

nodeJS/express/controllers.md

+
+#### Application-level middleware
+
+Application-level middleware are bound to an *instance of Express* using the app.use or using app.METHOD (e.g. app.get, app.post) functions. These are middlewares that are executed in **every incoming requests** to the application with the specified path `/` being the default mount path (mount path can be changed by adding it as the first argument), but if the request-response cycle ends before even getting to the specific middleware then it will of course not run, but typically these middlewares are placed on top of your application code to ensure they always run first. Very common built-in middlewares that you will likely use are:


Suggested change

Application-level middleware are bound to an *instance of Express* using the app.use or using app.METHOD (e.g. app.get, app.post) functions. These are middlewares that are executed in **every incoming requests** to the application with the specified path `/` being the default mount path (mount path can be changed by adding it as the first argument), but if the request-response cycle ends before even getting to the specific middleware then it will of course not run, but typically these middlewares are placed on top of your application code to ensure they always run first. Very common built-in middlewares that you will likely use are:

Application-level middleware are bound to an *instance of Express* using `app.use` or using `app.<METHOD>` (e.g. `app.get`, `app.post`) functions. These are middleware functions that are executed in **every incoming request** to the application with the specified path `/` being the default mount path (mount path can be changed by adding it as the first argument), but if the request-response cycle ends before even getting to the specific middleware then it will of course not run, but typically these middlewares are placed on top of your application code to ensure they always run first. Very common built-in middlewares that you will likely use are:

The first bit just has a few punctuation bits.
The second sentence ("These are middleware functions that...") is very verbose and quite difficult to digest. I'm not too sure we need to talk much about the default mount path. Or perhaps something like having separate sentences e.g.

These are middleware functions that are executed in every incoming request matching the specified path. If you don't specify a path, the path defaults to / which will match every incoming request. As with any middleware functions, they will not run if the request-response cycle ends before reaching them.

Thoughts?

Let's probably just remove the sentence regarding the mount path, since I would assume this is more useful and commonly used for attaching. routers and will probably be discussed in the router lesson, what do you think?

Makes sense I think. Can always revisit this depending on exactly what the routes lesson goes through and how.

nodeJS/express/controllers.md

Co-authored-by: MaoShizhong <122839503+MaoShizhong@users.noreply.github.com>

…with middleware

fcasibu · 2024-04-05T07:07:32Z

Resolved all unresolved comments, let me know if there was a mistake. Thanks

nodeJS/express/controllers.md

Co-authored-by: MaoShizhong <122839503+MaoShizhong@users.noreply.github.com>

01zulfi

@fcasibu this is a chonky lesson 🔥

Particularly love the error handling section. Super cool that it goes through custom errors as well.

Just left a couple of comments below, allow me more time later to dig into the content and code examples.

nodeJS/express/controllers.md

01zulfi · 2024-04-20T11:09:35Z

nodeJS/express/controllers.md

+
+A middleware function typically takes three parameters (however, there is one that we will get into later that has four):
+
+**NOTE**: Names are just convention, you can name them whatever you want `req -> request, res -> response, etc`


I think this note should be after the list that explains the parameters

Co-authored-by: 01zulfi <85733202+01zulfi@users.noreply.github.com>

01zulfi · 2024-05-04T08:54:23Z

nodeJS/express/controllers.md

+- `res` - The response object, which represents the HTTP response that will be sent back to the client.
+- `next` - The function that pass the control to the next middleware function in the chain (we'll get to this later). This is optional.
+
+**NOTE**: Names are just convention, you can name them whatever you want `req -> request, res -> response, etc`


Can we have this note in the lesson note styling?

nodeJS/express/controllers.md

01zulfi · 2024-05-04T08:57:58Z

nodeJS/express/controllers.md

+
+#### Router-level middleware
+
+Router-level middleware works similarly to application-level middlewares but is bound to an *instance of Express router* using router.use or router.METHOD (e.g. router.get) functions. This however is only executed when the request matches the specific route as you've probably already learned in the Routes lesson.


Can we have syntax highlighting for router.use and router.METHOD?

nodeJS/express/controllers.md

01zulfi · 2024-05-04T09:09:27Z

nodeJS/express/controllers.md

+  res.send(`User found: ${user.name}`);
+});
+```
+


Can we add a lesson note of tip variant here? It should say something along the lines:

the asyncHandler function in the express-async-handler function is just 6 lines of code. try to take a guess on how it's implemented and then do check out the source code for yourself.

Should I remove It essentially just chains a catch to "catch" any errors in the function above and let them take a guess instead like described here?

Removed it but let me know about your thoughts on that

01zulfi · 2024-05-04T09:10:38Z

nodeJS/express/controllers.md

+- `req` - The request object, which represents the incoming HTTP request.
+- `res` - The response object, which represents the HTTP response that will be sent back to the client.
+- `next` - The function that pass the control to the *next* middleware function (We'll get to this later). This is optional.


we don't need to explain these params again

Condensed it to

It is the same as the previous middleware functions with three parameters but with one new parameter in a different order which is the error object. This is an odd one but the error object must be the first parameter in the callback.

nodeJS/express/controllers.md

01zulfi · 2024-05-04T09:16:19Z

nodeJS/express/controllers.md

+router.route('/')
+  .get(userController.getUsers)
+  .post(userController.createUser);
+  // You will likely place your validation/authentication middleware functions here or perhaps in the controller file, e.g.
+  // .post(validationMiddleware, userController.createUser)
+
+router.route('/:id')
+  .get(userController.getUserById);
+
+module.exports = router;


can we follow the router.get("route") and router.post("route") syntax, since that's what we use in other lessons.

Co-authored-by: 01zulfi <85733202+01zulfi@users.noreply.github.com>

github-actions bot added the Content: NodeJS Involves the NodeJS course label Mar 26, 2024

fcasibu force-pushed the node-revamp/nodejs-controllers-lesson branch 7 times, most recently from 4bd9aab to f17bd6d Compare March 27, 2024 04:01

feat: add lesson for mvc controllers

0b67561

fcasibu force-pushed the node-revamp/nodejs-controllers-lesson branch from f17bd6d to 0b67561 Compare March 27, 2024 05:11

style: format lesson file for controllers

f449a83

fcasibu force-pushed the node-revamp/nodejs-controllers-lesson branch from bec9a1a to f449a83 Compare March 27, 2024 05:24

01zulfi self-requested a review March 27, 2024 09:29

01zulfi added the Project Node Revamp Issues/PRs related to the Node Revamp project label Mar 27, 2024

01zulfi self-assigned this Mar 28, 2024

fcasibu added 3 commits March 28, 2024 19:22

fix typo, incorrect link, and expand a little bit on explanation for …

91e4ff2

…status

expand a bit more on controller and error middleware

58d561d

update code snippet lang, add additional resource, and list out next …

30549de

…middleware arguments

fcasibu force-pushed the node-revamp/nodejs-controllers-lesson branch 4 times, most recently from 0bd8e04 to 0cc9f09 Compare March 31, 2024 07:53

add more examples

bc5e301

fcasibu force-pushed the node-revamp/nodejs-controllers-lesson branch from 0cc9f09 to bc5e301 Compare April 1, 2024 06:26

MaoShizhong reviewed Apr 1, 2024

View reviewed changes

fcasibu and others added 2 commits April 2, 2024 10:33

Apply suggestions from code review

712e10d

Co-authored-by: MaoShizhong <122839503+MaoShizhong@users.noreply.github.com>

remove default status calls

48196ad

fcasibu force-pushed the node-revamp/nodejs-controllers-lesson branch from 776aaea to 48196ad Compare April 2, 2024 02:35

MaoShizhong reviewed Apr 4, 2024

View reviewed changes

fcasibu commented Apr 4, 2024

View reviewed changes

nodeJS/express/controllers.md Outdated Show resolved Hide resolved

fcasibu and others added 3 commits April 4, 2024 19:14

Apply suggestions from code review

6fddd3b

Co-authored-by: MaoShizhong <122839503+MaoShizhong@users.noreply.github.com>

Update nodeJS/express/controllers.md

5aa1517

Co-authored-by: MaoShizhong <122839503+MaoShizhong@users.noreply.github.com>

resolve capitalizing express, end list with periods, change of terms …

99bd077

…with middleware

MaoShizhong reviewed Apr 14, 2024

View reviewed changes

nodeJS/express/controllers.md Outdated Show resolved Hide resolved

MaoShizhong reviewed Apr 14, 2024

View reviewed changes

nodeJS/express/controllers.md Outdated Show resolved Hide resolved

fcasibu and others added 2 commits April 15, 2024 12:58

Apply suggestions from code review

5a01169

Co-authored-by: MaoShizhong <122839503+MaoShizhong@users.noreply.github.com>

fix typos and file inconsistency

6b5a2f5

01zulfi requested changes Apr 20, 2024

View reviewed changes

fcasibu and others added 3 commits April 28, 2024 16:27

Apply suggestions from code review

7f3ee96

Co-authored-by: 01zulfi <85733202+01zulfi@users.noreply.github.com>

Merge branch 'main' into node-revamp/nodejs-controllers-lesson

cd58e10

move note below the explanation of each parameter

818ecec

fcasibu requested a review from 01zulfi April 28, 2024 08:33

01zulfi requested changes May 4, 2024

View reviewed changes

Apply suggestions from code review

28e1566

Co-authored-by: 01zulfi <85733202+01zulfi@users.noreply.github.com>

fcasibu force-pushed the node-revamp/nodejs-controllers-lesson branch from cc01fa5 to 28e1566 Compare May 11, 2024 10:04

fcasibu requested review from 01zulfi and MaoShizhong May 11, 2024 10:05

MaoShizhong mentioned this pull request May 11, 2024

Node revamp: PostgreSQL lessons #27960

Open

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Node revamp: Controllers Lesson #27695

Node revamp: Controllers Lesson #27695

fcasibu commented Mar 26, 2024

MaoShizhong left a comment

fcasibu commented Apr 2, 2024

MaoShizhong left a comment •

edited

MaoShizhong Apr 4, 2024

fcasibu Apr 4, 2024

MaoShizhong Apr 4, 2024 •

edited

fcasibu commented Apr 5, 2024

01zulfi left a comment •

edited

01zulfi Apr 20, 2024

01zulfi May 4, 2024

01zulfi May 4, 2024

01zulfi May 4, 2024

fcasibu May 11, 2024 •

edited

fcasibu May 11, 2024

01zulfi May 4, 2024

fcasibu May 11, 2024

01zulfi May 4, 2024


		#### Application-level middleware

		Application-level middleware are bound to an instance of Express using the app.use or using app.METHOD (e.g. app.get, app.post) functions. These are middlewares that are executed in every incoming requests to the application with the specified path `/` being the default mount path (mount path can be changed by adding it as the first argument), but if the request-response cycle ends before even getting to the specific middleware then it will of course not run, but typically these middlewares are placed on top of your application code to ensure they always run first. Very common built-in middlewares that you will likely use are:


		A middleware function typically takes three parameters (however, there is one that we will get into later that has four):

		NOTE: Names are just convention, you can name them whatever you want `req -> request, res -> response, etc`


		#### Router-level middleware

		Router-level middleware works similarly to application-level middlewares but is bound to an instance of Express router using router.use or router.METHOD (e.g. router.get) functions. This however is only executed when the request matches the specific route as you've probably already learned in the Routes lesson.

Node revamp: Controllers Lesson #27695

Are you sure you want to change the base?

Node revamp: Controllers Lesson #27695

Conversation

fcasibu commented Mar 26, 2024

Because

This PR

Issue

Additional Information

Pull Request Requirements

MaoShizhong left a comment

Choose a reason for hiding this comment

fcasibu commented Apr 2, 2024

MaoShizhong left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MaoShizhong Apr 4, 2024 • edited

Choose a reason for hiding this comment

fcasibu commented Apr 5, 2024

01zulfi left a comment • edited

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

fcasibu May 11, 2024 • edited

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

MaoShizhong left a comment •

edited

MaoShizhong Apr 4, 2024 •

edited

01zulfi left a comment •

edited

fcasibu May 11, 2024 •

edited