Guides: request lifecycle and custom error pages #5068

rktjmp · 2022-11-03T09:28:48Z

No description provided.

rktjmp · 2022-11-03T09:29:43Z

guides/request_lifecycle.md

+Our messenger appears as `@messenger`.
+
+The values we passed to the view from the controller are collectively called our "assigns". We could access our messenger value via `assigns.messenger` but through some metaprogramming, Phoenix gives us the much cleaner `@` syntax for use in templates.


"We call "assigns" the values passed from the controller to views" read a bit backwards.

rktjmp · 2022-11-03T09:30:31Z

guides/request_lifecycle.md

+Remember our templates are written in HEEx (HTML+EEx). HEEx is a superset of EEx which is why it shares the `<%= %>` syntax.
+


New users might get tripped up by "EEx tags" vs "aren't we writing HEEx?" so this tries to head that off at the pass.

rktjmp · 2022-11-03T09:30:47Z

guides/request_lifecycle.md

+ Here we are telling `Phoenix.Component` to embed all `.heex` templates found in the sibling `hello` directory into our module as function definitions.
+
+ Next, we need to add files to the `lib/hello_web/controllers/hello_html` directory.
+
+ Note the controller name (`HelloController`), the view name (`HelloHTML`), and the template directory (`hello`) all follow the same naming convention and are named after each other. They are also collocated together in the directory tree:


Just white space so the important "next we" doesn't get lost.

rktjmp · 2022-11-03T09:31:32Z

guides/request_lifecycle.md

@@ -117,7 +117,11 @@ defmodule HelloWeb.HelloHTML do
 end
 ```

-Now in order to add templates to this view, we can either define them as function components directly in the module:


This "either ..." was missing its friend, so i colocated both parts, functions and files then expand on them.

rktjmp · 2022-11-03T09:32:02Z

guides/request_lifecycle.md

-Now in order to add templates to this view, we can either define them as function components directly in the module:
+To add templates to this view, we can define them as function components in the module or in separate files. Function components are great for smaller templates and separate files are a good choice when you have a lot of markup or your functions start to feel unmanageable.
+
+Both functional components and template files are compiled to an internal format, there is no runtime or performance difference between them.


Pretty sure this is true^1 and should ease some new users questions ("are files slower? does it read each time?")

at least in prod, which I debated noting down but thought it was a bit much.

I think instead of this line we could say:

Template files are compiled into the module, so there is no runtime or performance difference between using a separate file or the ~H sigil.

I think using the term "~H sigil" might be premature as we've not discussed ~H or sigils yet (it is in the next post-code para though). The reader might go "what is a function component? wait what is ~H?" vs reusing the same terms we just outlaid.

How do you feel about this?

To add templates to this view, we can define them as function components in the module or in separate files. Function components are great for smaller templates and separate files are a good choice when you have a lot of markup or your functions start to feel unmanageable.

Template files are compiled into the module as function components themselves, there is no runtime or performance difference between the two styles.

The only real key point I think we need to make is that the reader shouldn't stress about picking between the two!

rktjmp · 2022-11-03T09:32:36Z

guides/howto/custom_error_pages.md

@@ -27,7 +27,7 @@ defmodule HelloWeb.ErrorHTML do
  end
 end

-defmodule HelloWeb.ErrorJSOn do
+defmodule HelloWeb.ErrorJSON do


rktjmp · 2022-11-03T09:32:40Z

guides/howto/custom_error_pages.md


-They are rendered in the error page as a collection of buttons and follow the format of:
+When `debug_errors` is `true`, they are rendered in the error page as a collection of buttons and follow the format of:


The user may have turned this off previously in the guide, so important to note.

Gazler

Good changes. I've made one small suggestion that clarifies slightly what happens with template files.

Gazler · 2022-11-08T15:16:54Z

guides/request_lifecycle.md

-Now in order to add templates to this view, we can either define them as function components directly in the module:
+To add templates to this view, we can define them as function components in the module or in separate files. Function components are great for smaller templates and separate files are a good choice when you have a lot of markup or your functions start to feel unmanageable.
+
+Both functional components and template files are compiled to an internal format, there is no runtime or performance difference between them.


I think instead of this line we could say:

Template files are compiled into the module, so there is no runtime or performance difference between using a separate file or the ~H sigil.

rktjmp · 2022-11-09T10:12:27Z

Fixed merge conflict & applied feedback

Gazler · 2022-11-09T11:23:32Z

Thanks <3

rktjmp commented Nov 3, 2022

View reviewed changes

rktjmp marked this pull request as ready for review November 3, 2022 09:33

Eiji7 approved these changes Nov 7, 2022

View reviewed changes

Gazler reviewed Nov 8, 2022

View reviewed changes

rktjmp added 7 commits November 9, 2022 21:07

Fix custom_error_pages JSOn -> JSON

e33344d

Note that actionable errors only work when debug_errors is true

2a50695

Adjust hanging-either and tweak function vs file templates explanation

60844bd

Remind reader of relationship between HEEx and EEx

e5c61c6

Alter slightly awkward "assigns" discussion

e18dce6

Exception actions are triggered from, not by, the error page

58b8354

Tweak func-comp vs template-files discussion

6c449e7

rktjmp force-pushed the doc-guide-fixes branch from 5f65f09 to 6c449e7 Compare November 9, 2022 10:11

Gazler merged commit fc6a55b into phoenixframework:master Nov 9, 2022

rktjmp mentioned this pull request Nov 9, 2022

Fix hello_html directory name #5093

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Guides: request lifecycle and custom error pages #5068

Guides: request lifecycle and custom error pages #5068

rktjmp commented Nov 3, 2022

rktjmp Nov 3, 2022

rktjmp Nov 3, 2022

rktjmp Nov 3, 2022 •

edited

Loading

rktjmp Nov 3, 2022

rktjmp Nov 3, 2022 •

edited

Loading

Gazler Nov 8, 2022

rktjmp Nov 9, 2022

Gazler Nov 9, 2022

rktjmp Nov 3, 2022

rktjmp Nov 3, 2022

Gazler left a comment

Gazler Nov 8, 2022

rktjmp commented Nov 9, 2022

Gazler commented Nov 9, 2022

		Our messenger appears as `@messenger`.

		The values we passed to the view from the controller are collectively called our "assigns". We could access our messenger value via `assigns.messenger` but through some metaprogramming, Phoenix gives us the much cleaner `@` syntax for use in templates.

		Remember our templates are written in HEEx (HTML+EEx). HEEx is a superset of EEx which is why it shares the `<%= %>` syntax.


		They are rendered in the error page as a collection of buttons and follow the format of:
		When `debug_errors` is `true`, they are rendered in the error page as a collection of buttons and follow the format of:

Guides: request lifecycle and custom error pages #5068

Guides: request lifecycle and custom error pages #5068

Conversation

rktjmp commented Nov 3, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rktjmp Nov 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rktjmp Nov 3, 2022 • 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

Gazler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rktjmp commented Nov 9, 2022

Gazler commented Nov 9, 2022

rktjmp Nov 3, 2022 •

edited

Loading

rktjmp Nov 3, 2022 •

edited

Loading