chore: Refactor site to improve testing (#2014)

kylecarbs · web-flow · commit 61aacff44477 · 2022-06-03T04:27:21.000Z
It was difficult to develop this package due to the
embed build tag being mandatory on the tests. The logic
to test doesn't require any embedded files.
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -334,7 +334,7 @@ func New(options *Options) *API {
 			r.Get("/state", api.workspaceBuildState)
 		})
 	})
-	r.NotFound(site.DefaultHandler().ServeHTTP)
+	r.NotFound(site.Handler(site.FS()).ServeHTTP)
 
 	return api
 }
diff --git a/site/embed_slim.go b/site/embed_slim.go
diff --git a/site/site.go b/site/site.go
@@ -1,11 +1,7 @@
-//go:build embed
-// +build embed
-
 package site
 
 import (
 	"bytes"
-	"embed"
 	"fmt"
 	"io"
 	"io/fs"
@@ -21,26 +17,6 @@ import (
 	"golang.org/x/xerrors"
 )
 
-// The `embed` package ignores recursively including directories
-// that prefix with `_`. Wildcarding nested is janky, but seems to
-// work quite well for edge-cases.
-//go:embed out
-//go:embed out/bin/*
-var site embed.FS
-
-func DefaultHandler() http.Handler {
-	// the out directory is where webpack builds are created. It is in the same
-	// directory as this file (package site).
-	siteFS, err := fs.Sub(site, "out")
-
-	if err != nil {
-		// This can't happen... Go would throw a compilation error.
-		panic(err)
-	}
-
-	return Handler(siteFS)
-}
-
 // Handler returns an HTTP handler for serving the static site.
 func Handler(fileSystem fs.FS) http.Handler {
 	// html files are handled by a text/template. Non-html files
diff --git a/site/site_embed.go b/site/site_embed.go
@@ -0,0 +1,24 @@
+//go:build embed
+// +build embed
+
+package site
+
+import (
+	"embed"
+	"io/fs"
+)
+
+//go:embed out
+//go:embed out/bin/*
+var site embed.FS
+
+func FS() fs.FS {
+	// the out directory is where webpack builds are created. It is in the same
+	// directory as this file (package site).
+	out, err := fs.Sub(site, "out")
+	if err != nil {
+		// This can't happen... Go would throw a compilation error.
+		panic(err)
+	}
+	return out
+}
diff --git a/site/site_slim.go b/site/site_slim.go
@@ -0,0 +1,15 @@
+//go:build !embed
+// +build !embed
+
+package site
+
+import (
+	"embed"
+	"io/fs"
+)
+
+var slim embed.FS
+
+func FS() fs.FS {
+	return slim
+}
diff --git a/site/site_test.go b/site/site_test.go
@@ -1,6 +1,3 @@
-//go:build embed
-// +build embed
-
 package site_test
 
 import (

Original file line number	Diff line number	Diff line change
`@@ -334,7 +334,7 @@ func New(options Options) API {`
`334`	`334`	`r.Get("/state", api.workspaceBuildState)`
`335`	`335`	`})`
`336`	`336`	`})`
`337`		`- r.NotFound(site.DefaultHandler().ServeHTTP)`
	`337`	`+ r.NotFound(site.Handler(site.FS()).ServeHTTP)`
`338`	`338`
`339`	`339`	`return api`
`340`	`340`	`}`