prepared v1.4.0 release, change log and README

Author: dstpierre

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog for StaticBackend
 
+### Sep 04, 2022 v1.4.0
+
+Features:
+
+* Dev cache impl now handle pub/sub (thanks @rostikts)
+* New server-side runtime function allowing to make HTTP requests (thanks @ksankeerth)
+* Magic link to login without entering password
+* Clean up log output via zerolog (thanks @VladPetriv)
+* Ability to update multiple documents from a query. (thanks @rostikts)
+* UI list uploaded files. (thanks @VladPetriv)
+* Added `/me` endpoint that returns current user with their role.
+* Creation of the `config` package to holw all configuration variables
+* In memory datastore and cache (for local dev / CLI)
+
+Bug fixes:
+
+* Fixed bug when calling List/Query when collection did not exists (thanks @rostikts)
+* Fixed a bug with PostgreSQL read/write permission
+* Fixed issue when serving local store files.
+* Fixed UI displaying internal SB collections
+* Fixed Go version in DockerFile (thanks @MyWay)
+* Fixed issue with PostgreSQL schema name not starting with a letter
+
+
 ### Mar 16, 2022 v1.3.0
 
 * Feature: resize image when uploading

README.md

@@ -10,9 +10,12 @@
 
 </p>
 
+p.s. If you'd like to contribute to an active Go project, you've found a nice 
+one in my biased opinion.
+
 # StaticBackend - simple backend for your apps
 
-[StaticBackend](https://staticbackend.com) is a simple backend that handles 
+[StaticBackend](https://staticbackend.com) is a simple backend API that handles 
 user management, database, file storage, forms, real-time experiences via 
 channel/topic-based communication, and server-side functions for web and mobile 
 applications.
@@ -42,6 +45,8 @@ a good fit.
 
 I'm personally using it to build SaaS:
 
+[En Pyjama - an online course platform for kids](https://enpyjama.com)
+
 Abandoned projects:
 
 * [Vivid - Automatic video clips for podcasts](https://vivid.fm)
@@ -74,7 +79,7 @@ const bkn = new Backend("your_public-key", "dev");
 let token = "";
 
 login = async () => {
-	const res = await bkn.login("[email protected]", "password");
+	const res = await bkn.register("[email protected]", "password");
 	if (!res.ok) {
 		console.error(res.content);
 		return;
@@ -210,8 +215,7 @@ Please help us improve if you have any feedback.
 
 We [provide a CLI](https://staticbackend.com/getting-started/) for local 
 development if you want to get things started without any infrastructure and 
-for prototyping / testing. Please note the dev server has a very limited 
-functionalities compares to the full self-hosted version.
+for prototyping / testing.
 
 You can use the CLI to manage your database, form submissions, and deploy 
 server-side-functions. We have an alpha Web UI as well to manage your resources.
@@ -262,4 +266,4 @@ If you're looking to help the project, here are some ways:
 * Use it and share your experiences.
 * Sponsor the development via GitHub sponsors.
 * Spread the words, a tweet, a blog post, any mention is helpful.
-* Join the Discord server.
+* Join the [Discord](https://discord.gg/vgh2PTp9ZB) server.

account.go

@@ -231,14 +231,20 @@ Admin user:
 	Password:	%s
 
 
-Root token:		%s
+Dev root token:		safe-to-use-in-dev-root-token
+Real root token:		%s
 
 
 Refer to the documentation at https://staticbackend.com/docs\n
 
 `,
 			bc.ID, email, pw, rootToken,
 		)
+
+		// cache the root token so caller can always use
+		// "safe-to-use-in-dev-root-token" as root token instead of
+		// the changing one across CLI start/stop
+		volatile.Set("dev-root-token", rootToken)
 	} else {
 		err = emailer.Send(ed)
 		if err != nil {

db_test.go

@@ -69,7 +69,7 @@ func dbReq(t *testing.T, hf func(http.ResponseWriter, *http.Request), method, pa
 	if params[0] {
 		stdAuth = []middleware.Middleware{
 			middleware.WithDB(datastore, volatile, getStripePortalURL),
-			middleware.RequireRoot(datastore),
+			middleware.RequireRoot(datastore, volatile),
 		}
 	}
 	h := middleware.Chain(http.HandlerFunc(hf), stdAuth...)
@@ -154,7 +154,7 @@ func TestDBListCollections(t *testing.T) {
 
 	stdRoot := []middleware.Middleware{
 		middleware.WithDB(datastore, volatile, getStripePortalURL),
-		middleware.RequireRoot(datastore),
+		middleware.RequireRoot(datastore, volatile),
 	}
 	h := middleware.Chain(http.HandlerFunc(database.listCollections), stdRoot...)
 
@@ -189,7 +189,7 @@ func TestListDocumentsInvalidDB(t *testing.T) {
 
 	stdRoot := []middleware.Middleware{
 		middleware.WithDB(datastore, volatile, getStripePortalURL),
-		middleware.RequireRoot(datastore),
+		middleware.RequireRoot(datastore, volatile),
 	}
 	h := middleware.Chain(http.HandlerFunc(database.list), stdRoot...)
 
@@ -312,7 +312,7 @@ func TestDBCreateIndex(t *testing.T) {
 
 	stdRoot := []middleware.Middleware{
 		middleware.WithDB(datastore, volatile, getStripePortalURL),
-		middleware.RequireRoot(datastore),
+		middleware.RequireRoot(datastore, volatile),
 	}
 	h := middleware.Chain(http.HandlerFunc(database.index), stdRoot...)
 

middleware/auth.go

@@ -120,7 +120,7 @@ func ValidateAuthKey(datastore internal.Persister, volatile internal.PubSuber, c
 	return a, nil
 }
 
-func RequireRoot(datastore internal.Persister) Middleware {
+func RequireRoot(datastore internal.Persister, volatile internal.PubSuber) Middleware {
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			key := r.Header.Get("Authorization")
@@ -146,6 +146,22 @@ func RequireRoot(datastore internal.Persister) Middleware {
 
 			key = strings.Replace(key, "Bearer ", "", -1)
 
+			// in dev mode the cache will have a key called:
+			// dev-root-token which hold the dynamically changing root token
+			// which changes each stop/start of the CLI. Using
+			// "safe-to-use-in-dev-root-token" as root token will
+			// get the real root token removing the need to update the root token
+			// in dev mode
+			if key == "safe-to-use-in-dev-root-token" {
+				rt, err := volatile.Get("dev-root-token")
+				if err != nil {
+					http.Error(w, "not in dev mode", http.StatusUnauthorized)
+					return
+				}
+
+				key = rt
+			}
+
 			ctx := r.Context()
 			conf, ok := ctx.Value(ContextBase).(internal.BaseConfig)
 			if !ok {

server.go

@@ -138,7 +138,7 @@ func Start(c config.AppConfig, log *logger.Logger) {
 
 	stdRoot := []middleware.Middleware{
 		middleware.WithDB(datastore, volatile, getStripePortalURL),
-		middleware.RequireRoot(datastore),
+		middleware.RequireRoot(datastore, volatile),
 	}
 
 	m := &membership{log: log}