faasify

module
v0.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 4, 2024 License: MIT

README

faasify - A framework for building a simple and blazingly fast FaaS server from scratch

Compile the server with a security token

./scripts/compile.sh

Run the server in development mode

Use the default (domain=localhost, url=https://localhost:3000)

./build/server 

Or specify the domain and url with args:

./build/server -domain localhost -url https://localhost:3000

Call a function with curl and security token

curl -H "Authorization: Bearer $(cat ./security/token)" https://localhost:3000/hello

Display the demo page

https://127.0.0.1:3000/index

Login with the username faasify and the security token in security/token as the password.

Add functions

Create a new function named count:

mkdir ./functions/count

Add a function named HandlerFunc() like the following:

vim ./functions/count/handler.go

package count

type Request struct{}
type Response struct {
	Count int    `json:"count"`
	Error string `json:"error"`
}

var (
	count int
	mutex sync.Mutex
)

func HandlerFunc(cfg *config.Config) http.HandlerFunc {
	count = 0
	return func(w http.ResponseWriter, r *http.Request) {
		server.Process[Request, Response](w, r, func(req Request) (Response, error) {
			mutex.Lock()
			defer mutex.Unlock()
			count++
			return Response{Count: count}, nil
		})
	}
}

Add a handler test on steroids like this:


package count_test

func TestCountSuccess(t *testing.T) {
	cfg := &config.Config{}
	fn := count.HandlerFunc(cfg)
	req := count.Request{}
	res, err := server.Validate[count.Request, count.Response](fn, "count", req, cfg)
	assert.That("no error is returned", t, err, nil)
	assert.That("count is 1", t, res.Count, 1)
}

The function routing gets updated on compile time, based on the contents of the functions directory.

Run the server in production mode

Start server with TLS support:

sudo ./build/server -domain your.domain -mode prod -url https://your.domain

Directories

Path Synopsis
cmd
internal
http/server
Code generated by fassify DO NOT EDIT
Code generated by fassify DO NOT EDIT
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL