Template Updates #8
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cratelyn
commented
Apr 14, 2020
triblondon
reviewed
Apr 16, 2020
triblondon
reviewed
Apr 16, 2020
triblondon
reviewed
Apr 16, 2020
added 3 commits
April 20, 2020 14:41
This makes a few minor stylistic changes to our `main.rs` template: * use builder to generate internal error response * describe error case in doc comment * move `main` to top of program * move valid methods array into `handle_request` * move backend constants to top, add docs
This PR removes the links in the documentation comments of `main` and `handle_request` in our template. While Rust documentation comments often include markdown links, this program template actually isn't a fantastic place to use this functionality. Most often, these comments will be viewed directly in the source code. Another important point against these is that neither of these functions are exported with `pub`. Consequentially, they won't show up in `cargo doc --open`. At best, they would appear in auto-completion dialogues in editors like VSCode, but this benefit isn't worth the impact to readability.
166ebef to
3be792c
Compare
cratelyn
commented
Apr 20, 2020
This was referenced Apr 22, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Template Changes
Here are some small changes to our template program. These are intended to address a few corners I've seen new users running into, namely: setting the correct backend name, and how users should handle errors in our application.
Overview
The most important changes are...
fastlyto version0.3.0#[fastly::main]procedural macro. (See: https://docs.rs/fastly/0.3.0/fastly/attr.main.html)"backend_name"literals up to the top of the file, into documentedconstvalues. This helps highlight the parts of our template that a user will always need to change, so people do not forget and run into cryptic hostcall error messages.maindocumentation explaining that returning an error will result in a 500 Internal Server Error response being sent back to the client. I think this is a small conceptual detail that isn't explained clearly currently.Small Changes
A few other small changes made in the process of this PR:
VALID_METHODSarray into ourhandle_requestfunction. This was done to try and emphasize theBACKEND_NAMEconsts, which must be changed for someone's service to work.