v0.6.3: LatestRelease <- Development (#84)

Author: lmbek

README.md

@@ -42,55 +42,36 @@ Example: how to add framework to main.go
 package main
 
 import (
+	"api"
 	"fmt"
+	"github.com/lmbek/gobek/fileserver"
 	"github.com/lmbek/gobek/launcher"
 	"os"
 )
 
-// For windows we need a organisation name and project name
-var organisationName = "NewOrganisationName" // put in organisation name
-var projectName = "NewProjectName"           // put in project name
+// For windows, we need an organisation name and project name
+var organisationName = "NewOrganisationName" 
+var projectName = "NewProjectName"           
 
-var frontendPath = "./frontend" // this should be set to where frontend files is (frontend folder: html, css, javascript...)
+// Set frontend path (where we have all the: html, css, javascript...)
+var frontendPath = "./frontend" 
 
 var chromeLauncher = launcher.ChromeLauncher{
 	Location:                os.Getenv("programfiles") + "\\Google\\Chrome\\Application\\chrome.exe",
-	FrontendInstallLocation: os.Getenv("localappdata") + "\\Google\\Chrome\\InstalledApps\\" + "DefaultOrganisationName" + "\\" + "DefaultProjectName",
+	FrontendInstallLocation: os.Getenv("localappdata") + "\\Google\\Chrome\\InstalledApps\\" + organisationName + "\\" + projectName,
 }
 
 var chromiumLauncher = launcher.DefaultChromiumLauncher // default chrome or chromium launcher settings can be used like this
 
-/*
-	// Otherwise they can also be customized like this
-
-	var chromiumLauncher = launcher.ChromiumLauncher{
-		Location:      "/var/lib/snapd/desktop/applications/chromium_chromium.desktop", // TODO: check if better location or can be customised
-		Domain:        "localhost",
-	}
-*/
-
 func main() {
-    // add your own API
-	//api.Init()
-	/*
-		var once sync.Once
-		once.Do(func() {
-			http.HandleFunc("/", fileserver.ServeFileServer)
-			http.HandleFunc("/api/", api.ServeAPIUseGZip)
-		})
-		err := launcher.Start(frontendPath, chromeLauncher, chromiumLauncher) // serves "/" as fileserver.ServeFileServer. If you want to manage "/", then use launcher.StartCustom() instead
-		if err != nil {
-			fmt.Println(err)
-		}
-	*/
+	//api.Init() // need to be added by you (example on gobek-example)
 	err := launcher.StartDefault(frontendPath, chromeLauncher, chromiumLauncher)
 	if err != nil {
 		fmt.Println(err)
 	}
 }
-
 </pre>
-
+Please do note however that using the main.go from the gobek-example project is recommended
 ## How to test
 <code>go test ./tests/...</code>
 
@@ -102,9 +83,3 @@ Use something like goversioninfo: https://github.com/josephspurrier/goversioninf
 
 ## How to build
 <code>go build -ldflags -H=windowsgui -o NewProjectName.exe</code>
-
-## How to make setup file and update functionality
-Coming later
-
-## Further plans
-Huge changes coming to version 0.7.0 that will change the whole project structure, this will break all versions before 0.7.0 when upgrading

fileserver/fileserver.go

@@ -10,20 +10,21 @@ import (
 	"net/http"
 	"os"
 	"os/signal"
-	"path"
 	"strings"
 	"syscall"
 	"time"
 )
 
 var FrontendPath = "./frontend" // should be set doing runtime by main.go
+
+// We want our server to serve requests without timeout, as we might want to make use of native features with some of them blocking
 var Server = http.Server{
 	Addr:              "localhost:0", // port is set on runtime
 	Handler:           nil,
 	TLSConfig:         nil,
-	ReadTimeout:       5 * time.Second,
-	ReadHeaderTimeout: 20 * time.Second,
-	WriteTimeout:      10 * time.Second,
+	ReadTimeout:       0,
+	ReadHeaderTimeout: 0,
+	WriteTimeout:      0,
 	IdleTimeout:       0,
 	MaxHeaderBytes:    0,
 	TLSNextProto:      nil,
@@ -35,7 +36,7 @@ var Server = http.Server{
 var ServerGraceShutdownTime = 5 * time.Second
 
 func SetServerAddress(address string) {
-	fmt.Println("address set to: " + address)
+	fmt.Println("Address set to: " + address)
 	Server.Addr = address
 }
 
@@ -63,72 +64,15 @@ func ServeFileServer(response http.ResponseWriter, request *http.Request) {
 func setHeaders(response http.ResponseWriter, request *http.Request) http.ResponseWriter {
 	// Headers can be set here
 
-	// set content-type for requested url path
-	contentType := getContentType(path.Ext(request.URL.Path))
-	response.Header().Set("Content-Type", contentType)
-
+	// We are using no caching because this is a local application, we could probably speed up application by making cache
 	response.Header().Set("Cache-Control", "no-store, no-cache, must-revalidate")
-	response.Header().Set("Expires", "Thu, 01 Jan 1970 00:00:00 GMT")
-
+	// response.Header().Set("Expires", "Thu, 01 Jan 1970 00:00:00 GMT")
+	// response.Header().Set("Cache-Control", "must-revalidate, max-age=31536000")
 	// Add Cache Cache-Control: max-age=31536000, immutable
 	// response.Header().Add("Cache-Control", "max-age=31536000, immutable")
 	return response
 }
 
-func getContentType(ext string) string {
-	if len(ext) == 0 {
-		return "text/html" // return and do not run further if no extension, we assume it is html
-	}
-
-	switch ext {
-	case ".html", ".htm", ".shtml":
-		return "text/html"
-	case ".css":
-		return "text/css"
-	case ".js":
-		return "application/javascript"
-	case ".json":
-		return "application/json"
-	case ".xml":
-		return "application/xml"
-	case ".pdf":
-		return "application/pdf"
-	case ".zip":
-		return "application/zip"
-	case ".gzip", ".gz":
-		return "application/gzip"
-	case ".png":
-		return "image/png"
-	case ".jpg", ".jpeg":
-		return "image/jpeg"
-	case ".gif":
-		return "image/gif"
-	case ".svg":
-		return "image/svg+xml"
-	case ".webp":
-		return "image/webp"
-	case ".ico":
-		return "image/x-icon"
-	case ".mp4":
-		return "video/mp4"
-	case ".webm":
-		return "video/webm"
-	case ".mp3":
-		return "audio/mpeg"
-	case ".wav":
-		return "audio/wav"
-	case ".ogg":
-		return "audio/ogg"
-	// cases like these below should be handled by an API, that should return something custom
-	//case ".exe":
-	//	return "application/octet-stream"
-	//case ".msi":
-	//	return "application/octet-stream"
-	default:
-		return "text/plain"
-	}
-}
-
 func Start() error {
 	err := Server.ListenAndServe()
 	if err != nil {

go.work

@@ -49,15 +49,15 @@ func (launcher *ChromeLauncher) launchForWindows() bool {
 		fileserver.SetServerAddress("localhost:" + port)
 
 		// Print the port that was found
-		fmt.Println("selected address with port: http://" + fileserver.GetServerAddress())
+		fmt.Println("Selected address with port: http://" + fileserver.GetServerAddress())
 
 		// Start frontend by starting a new Chrome process
 		path := launcher.Location
 
 		cmd = exec.Command(path, "--app=http://"+fileserver.GetServerAddress(), "--user-data-dir="+launcher.FrontendInstallLocation)
 		err = cmd.Start()
 		if err != nil {
-			println("Warning: Chrome could not start, is it installed?")
+			println("warning: Chrome could not start, is it installed?")
 		}
 
 		// Set up a signal handler to shutdown the program, when it should shutdown
@@ -107,19 +107,6 @@ func (launcher *ChromeLauncher) launchForWindows() bool {
 	return false
 }
 
-/*
-func (launcher *ChromeLauncher) assertChromeIsInstalled() {
-	// check if chrome.exe is installed
-	_, err := os.Stat(launcher.Location)
-
-	// if not installed give warning
-	if err != nil {
-		//messageboxw.WarningYouNeedToInstallChrome()
-		os.Exit(0)
-	}
-}
-*/
-
 func (launcher *ChromeLauncher) isApplicationInstalled() bool {
 	// check if this application is installed
 	_, err := os.Stat(launcher.FrontendInstallLocation)

launcher/chromeLauncher.go

@@ -11,8 +11,6 @@ import (
 	"time"
 )
 
-// TODO: in version 0.7.0 this should be splitted into each of the chrome/chromium launchers instead
-
 // SIMPLE VERSION
 func TestStart(test *testing.T) {
 	//tests.PrintGotFatalError(test, "NOT IMPLEMENTED YET!")