feat: front-end redesign to VueJS/Bootstrap 5 & server improvements

.github/workflows/build-vue.yml

@@ -0,0 +1,22 @@
+name: Build-VueJS
+
+on: [push, pull_request]
+
+jobs:
+  build-vue:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./static/terraboard-vuejs
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup NodeJS
+        uses: actions/setup-node@master
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build project
+        run: npm run build

Dockerfile

@@ -3,10 +3,17 @@ WORKDIR /opt/build
 COPY . .
 RUN make build
 
+FROM node:16.5-alpine3.14 as node-builder
+WORKDIR /opt/build
+COPY static/terraboard-vuejs ./terraboard-vuejs
+WORKDIR /opt/build/terraboard-vuejs
+RUN npm install
+RUN npm run build
+
 FROM scratch
 WORKDIR /
-COPY static /static
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 COPY --from=builder /opt/build/terraboard /
+COPY --from=node-builder /opt/build/terraboard-vuejs/dist /static
 ENTRYPOINT ["/terraboard"]
 CMD [""]

db/db.go

@@ -338,7 +338,8 @@ func (db *Database) SearchAttribute(query url.Values) (results []types.SearchRes
 	sqlQuery += " JOIN modules ON states.id = modules.state_id" +
 		" JOIN resources ON modules.id = resources.module_id" +
 		" JOIN attributes ON resources.id = attributes.resource_id" +
-		" JOIN lineages ON lineages.id = states.lineage_id"
+		" JOIN lineages ON lineages.id = states.lineage_id" +
+		" JOIN versions ON states.version_id = versions.id"
 
 	var where []string
 	var params []interface{}
@@ -388,7 +389,7 @@ func (db *Database) SearchAttribute(query url.Values) (results []types.SearchRes
 
 	// Now get results
 	// gorm doesn't support subqueries...
-	sql := "SELECT states.path, states.version_id, states.tf_version, states.serial, lineages.value as lineage_value, modules.path as module_path, resources.type, resources.name, resources.index, attributes.key, attributes.value" +
+	sql := "SELECT states.path, versions.version_id, states.tf_version, states.serial, lineages.value as lineage_value, modules.path as module_path, resources.type, resources.name, resources.index, attributes.key, attributes.value" +
 		sqlQuery +
 		" ORDER BY states.path, states.serial, lineage_value, modules.path, resources.type, resources.name, resources.index, attributes.key" +
 		" LIMIT ?"
@@ -678,15 +679,16 @@ func (db *Database) GetLineages(limitStr string) (lineages []types.Lineage) {
 	return
 }
 
-// DefaultVersion returns the detault VersionID for a given State path
+// DefaultVersion returns the default VersionID for a given Lineage
 // Copied and adapted from github.com/hashicorp/terraform/command/jsonstate/state.go
 func (db *Database) DefaultVersion(lineage string) (version string, err error) {
 	sqlQuery := "SELECT versions.version_id FROM" +
 		" (SELECT states.path, max(states.serial) as mx FROM states GROUP BY states.path) t" +
 		" JOIN states ON t.path = states.path AND t.mx = states.serial" +
 		" JOIN versions on states.version_id=versions.id" +
 		" JOIN lineages on lineages.id=states.lineage_id" +
-		" WHERE lineages.value = ?"
+		" WHERE lineages.value = ?" +
+		" ORDER BY versions.last_modified DESC"
 
 	row := db.Raw(sqlQuery, lineage).Row()
 	err = row.Scan(&version)

docker-compose.yml

@@ -18,8 +18,6 @@ services:
     depends_on:
       db:
         condition: service_healthy
-    volumes:
-      - ./static:/static:ro
     ports:
       - "8080:8080"
 

main.go

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"os"
+	"path/filepath"
 	"time"
 
 	"github.com/camptocamp/terraboard/api"
@@ -189,13 +191,8 @@ func main() {
 	apiRouter.HandleFunc(util.GetFullPath("plans"), handleWithDB(api.ManagePlans, database))
 
 	// Serve static files (CSS, JS, images) from dir
-	staticFs := http.FileServer(http.Dir("static"))
-	r.PathPrefix("/static/").Handler(http.StripPrefix("/static/", staticFs))
-
-	// Serve index page on all unhandled routes
-	r.PathPrefix("/").HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		http.ServeFile(w, r, "./static/index.html")
-	})
+	spa := spaHandler{staticPath: "static", indexPath: "index.html"}
+	r.PathPrefix("/").Handler(spa)
 
 	// Add CORS Middleware to mux router
 	r.Use(corsMiddleware)
@@ -204,3 +201,46 @@ func main() {
 	log.Debugf("Listening on port %d\n", c.Web.Port)
 	log.Fatal(http.ListenAndServe(fmt.Sprintf(":%v", c.Web.Port), r))
 }
+
+// spaHandler implements the http.Handler interface, so we can use it
+// to respond to HTTP requests. The path to the static directory and
+// path to the index file within that static directory are used to
+// serve the SPA in the given static directory.
+type spaHandler struct {
+	staticPath string
+	indexPath  string
+}
+
+// ServeHTTP inspects the URL path to locate a file within the static dir
+// on the SPA handler. If a file is found, it will be served. If not, the
+// file located at the index path on the SPA handler will be served. This
+// is suitable behavior for serving an SPA (single page application).
+func (h spaHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	// get the absolute path to prevent directory traversal
+	path, err := filepath.Abs(r.URL.Path)
+	if err != nil {
+		// if we failed to get the absolute path respond with a 400 bad request
+		// and stop
+		http.Error(w, err.Error(), http.StatusBadRequest)
+		return
+	}
+
+	// prepend the path with the path to the static directory
+	path = filepath.Join(h.staticPath, path)
+
+	// check whether a file exists at the given path
+	_, err = os.Stat(path)
+	if os.IsNotExist(err) {
+		// file does not exist, serve index.html
+		http.ServeFile(w, r, filepath.Join(h.staticPath, h.indexPath))
+		return
+	} else if err != nil {
+		// if we got an error (that wasn't that the file doesn't exist) stating the
+		// file, return a 500 internal server error and stop
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	// otherwise, use http.FileServer to serve the static dir
+	http.FileServer(http.Dir(h.staticPath)).ServeHTTP(w, r)
+}