Don't commit assets #199
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,3 +63,6 @@ typings/ | |
| Makefile.main | ||
| .ci | ||
| bin | ||
|
|
||
| # static included into go binary on release | ||
| /server/asset/asset.go | ||
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // +build with_static | ||
|
|
||
| package server | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/base64" | ||
| "encoding/json" | ||
| "io/ioutil" | ||
| "net/http" | ||
| "strings" | ||
|
|
||
| "github.com/bblfsh/web/server/asset" | ||
| ) | ||
|
|
||
| const ( | ||
| staticDirName = "static" | ||
| indexFileName = "/index.html" | ||
|
|
||
| serverValuesPlaceholder = "window.REPLACE_BY_SERVER" | ||
| footerPlaceholder = `<div class="invisible-footer"></div>` | ||
| ) | ||
|
|
||
| // Static contains handlers to serve static using esc | ||
| type Static struct { | ||
| fs http.FileSystem | ||
| options options | ||
| footerHTML []byte | ||
| } | ||
|
|
||
| // NewStatic creates new Static | ||
| func NewStatic(dir, serverURL string, footerHTML string) *Static { | ||
| var footerBytes []byte | ||
| if footerHTML != "" { | ||
| // skip incorrect base64 | ||
| footerBytes, _ = base64.StdEncoding.DecodeString(footerHTML) | ||
| } | ||
|
|
||
| return &Static{ | ||
| fs: asset.Dir(false, dir), | ||
| options: options{ | ||
| ServerURL: serverURL, | ||
| }, | ||
| footerHTML: footerBytes, | ||
| } | ||
| } | ||
|
|
||
| // struct which will be marshalled and exposed to frontend | ||
| type options struct { | ||
| ServerURL string `json:"SERVER_URL"` | ||
| } | ||
|
|
||
| // ServeHTTP serves any static file from static directory or fallbacks on index.hml | ||
| func (s *Static) ServeHTTP(w http.ResponseWriter, r *http.Request) { | ||
| _, err := s.fs.Open(r.URL.Path) | ||
| if err != nil { | ||
| if strings.HasPrefix(r.URL.Path, staticDirName) { | ||
| http.NotFound(w, r) | ||
| return | ||
| } | ||
|
|
||
| s.serveIndexHTML(nil)(w, r) | ||
| return | ||
| } | ||
|
|
||
| http.FileServer(s.fs).ServeHTTP(w, r) | ||
| } | ||
|
|
||
| // serveIndexHTML serves index.html file | ||
| func (s *Static) serveIndexHTML(initialState interface{}) http.HandlerFunc { | ||
| return func(w http.ResponseWriter, r *http.Request) { | ||
| f, err := s.fs.Open(indexFileName) | ||
| if err != nil { | ||
| http.NotFound(w, r) | ||
| return | ||
| } | ||
|
|
||
| b, err := ioutil.ReadAll(f) | ||
| if err != nil { | ||
| http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| options := s.options | ||
| bData, err := json.Marshal(options) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| b = bytes.Replace(b, []byte(serverValuesPlaceholder), bData, 1) | ||
| b = bytes.Replace(b, []byte(footerPlaceholder), s.footerHTML, 1) | ||
|
|
||
| w.Header().Add("Cache-Control", "no-cache, no-store, must-revalidate") | ||
|
|
||
| info, err := f.Stat() | ||
| if err != nil { | ||
| http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) | ||
| } | ||
|
|
||
| http.ServeContent(w, r, info.Name(), info.ModTime(), bytes.NewReader(b)) | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| // +build !with_static | ||
|
|
||
| package server | ||
|
|
||
| import ( | ||
| "net/http" | ||
| ) | ||
|
|
||
| // Static without the 'with_static' tag contains a placeholder handler | ||
| // that returns 'not implemented' | ||
| type Static struct{} | ||
|
|
||
| // NewStatic creates new Static | ||
| func NewStatic(dir, serverURL string, footerHTML string) *Static { | ||
| return &Static{} | ||
| } | ||
|
|
||
| // ServeHTTP serves any static file from static directory or fallbacks on index.hml | ||
| func (s *Static) ServeHTTP(w http.ResponseWriter, r *http.Request) { | ||
| http.Error(w, | ||
| "Frontend assets are only available when using 'make build' or 'make serve'", | ||
| http.StatusNotImplemented) | ||
|
|
||
| return | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this didn't came from lookout-web
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in lookout-web it looks like this: https://github.com/src-d/lookout/blob/master/Makefile.web#L69
same-same
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
kind of same functionality, but subtle different code (ie.
GO_RUN_ARGSdoes not appear in thatMakefile.web)But as I said, not blocker at all, so we can merge as it is.
(I also locally tested, and worked like a charm)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah. Maybe we can actually extract go-handler part & Makefile somewhere and then just re-use in our projects. @carlosms wdyt? Shall I create an issue for that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
I've been proposing that since years 🎉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sounds good to me. Let's open that issue :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/src-d/feature-idea/issues/129