Backend render html #171
Backend render html #171
Conversation
api.go
Outdated
| StatusCode int `json:"status_code"` | ||
| Message string `json:"message"` | ||
| Response interface{} `json:"response"` | ||
| TemplatePath string `json:"omit"` |
There was a problem hiding this comment.
I think you want json:"-" here?
api.go
Outdated
| StatusCode: http.StatusInternalServerError, | ||
| Message: err.Error(), | ||
| TemplatePath: "views/domain.html.tmpl", | ||
| } |
There was a problem hiding this comment.
How do you decide which APIResponses to transform into HTML templates? If this results in an error, what will template.Execute return?
There was a problem hiding this comment.
On api.go:86, we only attempt to render HTML if the template is set. Otherwise we respond to HTML requests as usual (with JSON or plain text). Non-200 responses return plain text, so noscript users would see a single line containing response.Message.
checker/result.go
Outdated
| STARTTLS: "Support for STARTTLS", | ||
| Version: "Secure version of TLS", | ||
| Certificate: "Valid certificate", | ||
| MTASTS: "Implementation of MTA-STS", |
There was a problem hiding this comment.
"Inbound MTA-STS support"
There was a problem hiding this comment.
Oh woops - I forgot to say that the strings and template text are basically dummy text I added - feel free to directly push edits. If it's just the ones in this review I'm happy to add them, but if you wanna tweak more things feel free :)
checker/result.go
Outdated
| // Text descriptions of checks that can be run | ||
| var checkNames = map[string]string{ | ||
| Connectivity: "Server connectivity", | ||
| STARTTLS: "Support for STARTTLS", |
There was a problem hiding this comment.
Support for inbound STARTTLS
views/scan.html.tmpl
Outdated
| {{ $r.Description }}: <strong>{{ $r.StatusText }}</strong> | ||
| <ul> | ||
| {{ range $_, $message := $r.Messages }} | ||
| <li>{{ $message }}<li> |
There was a problem hiding this comment.
| <li>{{ $message }}<li> | |
| <li>{{ $message }}</li> |
views/scan.html.tmpl
Outdated
| <p>{{ .Response.Data.Message }}</p> | ||
|
|
||
| <h2>STARTTLS Everywhere Policy List</h2> | ||
| {{ $r := index .Response.Data.ExtraResults "policylist" }} |
There was a problem hiding this comment.
If the status of this is bad, can we put in a link to /add-domain ?
views/domain.html.tmpl
Outdated
| {{ end }} | ||
| {{ if eq .Response.State "added" }} | ||
| Your domain is already on the STARTTLS policy list. Thanks for helping to make e-mail more secure. | ||
| {{ end }} |
| } | ||
| return APIResponse{StatusCode: http.StatusOK, Response: domainData} | ||
| // domainData.State = Unvalidated | ||
| // or queued? |
There was a problem hiding this comment.
Looked into this question - resolved in follow-up PR (and I removed the cryptic comment there).
| {{ end }} | ||
| </ul> | ||
| {{ if eq $r.Status 1 }} | ||
| <a href="{{ .BaseURL }}/add-domain">Add your email domain the STARTTLS Everywhere Policy List</a> |
There was a problem hiding this comment.
I also got a "can't evaluate field BaseURL in type *checker.Result" error here. Any idea what might have caused it?
There was a problem hiding this comment.
Weird, also GitHub isn't showing my other comment here. I think it should be $r.Status 2, not 1 since we ask them to sign up if it's a failure.
There was a problem hiding this comment.
Ohh with (line 18) changes the value of . in the template, so now the top-level variable is $r. It does a lot more than I thought it did!
|
I pushed a fuller test of the scan template with this (rendering a more realistic scan object). I think at some point it could be nice to add a fn to the checker package that generates typical scan objects. I'm often editing them in lots of places in tests when we change their structure. |
vbrown608
force-pushed
the
backend-render-html
branch
from
bae82de to
dcf6daa
Compare
vbrown608
force-pushed
the
backend-render-html
branch
from
dcf6daa to
3d6ff0f
Compare
|
Github is such a snitch now |
2 participants
I tried a couple things but wound up just putting some very simple strings on the backend and leaving the full descriptions on the frontend.