-
Notifications
You must be signed in to change notification settings - Fork 153
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expose OSS static asset handling to unify OSS/EE serving (#4007)
* Expose OSS static asset handling so we unify OSS/EE serving - Asset handling is growing more logic like injecting <base> tags - We should have the same code in OSS/EE * Implement CI suggestions --------- Co-authored-by: AlinaGoaga <[email protected]> Co-authored-by: AlinaGoaga <[email protected]>
- Loading branch information
3 people
authored
Dec 4, 2023
1 parent
6221c85
commit 6cbe63a
Showing
4 changed files
with
191 additions
and
64 deletions.
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
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,61 @@ | ||
| package server | ||
|
|
||
| import ( | ||
| "io" | ||
| "io/fs" | ||
| "net/http" | ||
| "path/filepath" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| ) | ||
|
|
||
| // AssetHandler returns a http.Handler that serves static assets from the provided fs.FS. | ||
| // It also redirects all non-file requests to index.html. | ||
| func AssetHandler(assetHandler, redirectHandler http.Handler) http.HandlerFunc { | ||
| return func(w http.ResponseWriter, req *http.Request) { | ||
| // Assume anything with a file extension in the name is a static asset. | ||
| extension := filepath.Ext(req.URL.Path) | ||
| // We use the golang http.FileServer for static file requests. | ||
| // This will return a 404 on normal page requests, ie /some-page. | ||
| // Redirect all non-file requests to index.html, where the JS routing will take over. | ||
| if extension == "" { | ||
| redirectHandler.ServeHTTP(w, req) | ||
| return | ||
| } | ||
| assetHandler.ServeHTTP(w, req) | ||
| } | ||
| } | ||
|
|
||
| // IndexHTMLHandler ensures that index.html always gets served. | ||
| // The JS router will take care of actual navigation once the index.html page lands. | ||
| func IndexHTMLHandler(fsys fs.FS, log logr.Logger, routePrefix string) http.HandlerFunc { | ||
| baseHref := GetBaseHref(routePrefix) | ||
| log.Info("Creating redirector", "routePrefix", routePrefix, "baseHref", baseHref) | ||
|
|
||
| return func(w http.ResponseWriter, r *http.Request) { | ||
| indexPage, err := fsys.Open("index.html") | ||
| if err != nil { | ||
| log.Error(err, "could not open index.html page") | ||
| http.Error(w, "could not open index.html page", http.StatusInternalServerError) | ||
| return | ||
| } | ||
| defer indexPage.Close() | ||
|
|
||
| bt, err := io.ReadAll(indexPage) | ||
| if err != nil { | ||
| log.Error(err, "could not read index.html") | ||
| http.Error(w, "could not read index.html", http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| // inject base tag into index.html | ||
| bt = InjectHTMLBaseTag(bt, baseHref) | ||
|
|
||
| _, err = w.Write(bt) | ||
| if err != nil { | ||
| log.Error(err, "error writing index.html") | ||
| http.Error(w, "error writing index.html", http.StatusInternalServerError) | ||
| return | ||
| } | ||
| } | ||
| } |
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,118 @@ | ||
| package server | ||
|
|
||
| import ( | ||
| "io" | ||
| "io/fs" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "os" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| ) | ||
|
|
||
| func TestCreateRedirector(t *testing.T) { | ||
| log := logr.Discard() | ||
| // Easiest way to create a filesystem.. | ||
| fsys, err := fs.Sub(os.DirFS("testdata"), "public") | ||
| if err != nil { | ||
| t.Fatalf("failed to create fs: %v", err) | ||
| } | ||
|
|
||
| t.Run("We read the index.html and inject base", func(t *testing.T) { | ||
| req := httptest.NewRequest("GET", "http://example.com/foo", nil) | ||
| w := httptest.NewRecorder() | ||
| handler := IndexHTMLHandler(fsys, log, "/prefix") | ||
|
|
||
| handler.ServeHTTP(w, req) | ||
|
|
||
| resp := w.Result() | ||
| body, _ := io.ReadAll(resp.Body) | ||
|
|
||
| // Check the status code | ||
| if resp.StatusCode != http.StatusOK { | ||
| t.Errorf("expected status OK; got %v", resp.StatusCode) | ||
| } | ||
|
|
||
| // Check that the base tag was injected | ||
| if !strings.Contains(string(body), `<base href="/prefix/">`) { | ||
| t.Errorf("base tag not injected correctly: %v", string(body)) | ||
| } | ||
| }) | ||
|
|
||
| t.Run("file not found", func(t *testing.T) { | ||
| brokenFS, err := fs.Sub(os.DirFS("testdata"), "nonexistent") | ||
| if err != nil { | ||
| t.Fatalf("failed to create fs: %v", err) | ||
| } | ||
| req := httptest.NewRequest("GET", "http://example.com/foo", nil) | ||
| w := httptest.NewRecorder() | ||
| handler := IndexHTMLHandler(brokenFS, log, "/prefix") | ||
|
|
||
| handler.ServeHTTP(w, req) | ||
|
|
||
| resp := w.Result() | ||
|
|
||
| // Check the status code | ||
| if resp.StatusCode != http.StatusInternalServerError { | ||
| t.Errorf("expected status InternalServerError; got %v", resp.StatusCode) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| func TestAssetHandlerFunc(t *testing.T) { | ||
| // Mock assetHandler to just record that it was called and with what request | ||
| assetHandler := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { | ||
| w.Write([]byte("assetHandler called")) | ||
| }) | ||
|
|
||
| // Mock redirector to just record that it was called and with what request | ||
| redirector := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { | ||
| w.Write([]byte("redirector called")) | ||
| }) | ||
|
|
||
| handler := AssetHandler(assetHandler, redirector) | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| requestURI string | ||
| wantStatus int | ||
| wantBody string | ||
| }{ | ||
| { | ||
| name: "Asset request with extension", | ||
| requestURI: "/static/somefile.js", | ||
| wantStatus: http.StatusOK, | ||
| wantBody: "assetHandler called", | ||
| }, | ||
| { | ||
| name: "Non-asset request", | ||
| requestURI: "/some-page", | ||
| wantStatus: http.StatusOK, | ||
| wantBody: "redirector called", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| req, err := http.NewRequest("GET", tt.requestURI, nil) | ||
| if err != nil { | ||
| t.Fatalf("could not create request: %v", err) | ||
| } | ||
|
|
||
| rr := httptest.NewRecorder() | ||
| handler(rr, req) | ||
|
|
||
| if rr.Code != tt.wantStatus { | ||
| t.Errorf("handler returned wrong status code: got %v want %v", | ||
| rr.Code, tt.wantStatus) | ||
| } | ||
|
|
||
| if rr.Body.String() != tt.wantBody { | ||
| t.Errorf("handler returned unexpected body: got %v want %v", | ||
| rr.Body.String(), tt.wantBody) | ||
| } | ||
| }) | ||
| } | ||
| } |
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,6 @@ | ||
| <html> | ||
| <head></head> | ||
| <body> | ||
| <h1>Index</h1> | ||
| </body> | ||
| </html> |