handler.go

@@ -0,0 +1,17 @@
+package joist
+
+import (
+	"fmt"
+	"net/http"
+)
+
+type (
+	HandlerFn    func(w http.ResponseWriter, r *http.Request) error
+	MiddlewareFn func(HandlerFn) HandlerFn
+)
+
+func (h HandlerFn) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	if err := h(w, r); err != nil {
+		http.Error(w, fmt.Sprintf(`An internal error has occurred: %s`, err), http.StatusInternalServerError)
+	}
+}

interfaces.go

@@ -0,0 +1,22 @@
+package joist
+
+import (
+	"context"
+	"time"
+)
+
+type Storer interface {
+	Close() error
+	Delete(ctx context.Context, key string) error
+	Get(ctx context.Context, key string) ([]byte, error)
+	GetForPrefix(ctx context.Context, prefix string) (map[string][]byte, error)
+	Put(ctx context.Context, key string, val []byte, ttl time.Duration) error
+}
+
+type RouteCacher interface {
+	Add(name string, path string) error
+	AddRouteInfo(routeInfo RouteInfo) error
+	GetPath(name string) (string, error)
+	GetRouteInfo(name string) (RouteInfo, error)
+	All() (map[string]string, error)
+}

internal/badger/badger.go

@@ -1,4 +1,4 @@
-package internal
+package badger
 
 import (
 	"context"
@@ -12,13 +12,6 @@ import (
 
 const defaultBaseDir = "./data/badger"
 
-type Storer interface {
-	Close() error
-	Delete(context.Context, string) error
-	Get(context.Context, string) ([]byte, error)
-	Put(context.Context, string, []byte, time.Duration) error
-}
-
 type BadgerOpts func(*badgerStore)
 
 func WithBaseDir(baseDir string) BadgerOpts {
@@ -58,6 +51,48 @@ func (b *badgerStore) Put(ctx context.Context, key string, val []byte, ttl time.
 	}
 }
 
+func (b *badgerStore) GetForPrefix(ctx context.Context, prefix string) (map[string][]byte, error) {
+	done := make(chan struct {
+		val map[string][]byte
+		err error
+	}, 1)
+
+	go func() {
+		valCopy := make(map[string][]byte)
+		err := b.db.View(func(txn *badger.Txn) error {
+			it := txn.NewIterator(badger.DefaultIteratorOptions)
+			defer it.Close()
+			prefix := []byte(prefix)
+			for it.Seek(prefix); it.ValidForPrefix(prefix); it.Next() {
+				item := it.Item()
+				k := item.Key()
+				err := item.Value(func(v []byte) error {
+					valCopy[string(k)] = v
+					return nil
+				})
+				if err != nil {
+					done <- struct {
+						val map[string][]byte
+						err error
+					}{make(map[string][]byte), err}
+				}
+			}
+			return nil
+		})
+		done <- struct {
+			val map[string][]byte
+			err error
+		}{valCopy, err}
+	}()
+
+	select {
+	case <-ctx.Done():
+		return nil, ctx.Err()
+	case res := <-done:
+		return res.val, nil
+	}
+}
+
 func (b *badgerStore) Get(ctx context.Context, key string) ([]byte, error) {
 	done := make(chan struct {
 		val []byte

internal/badger/badger_test.go

@@ -1,4 +1,4 @@
-package internal
+package badger
 
 import (
 	"context"

internal/errors/errors.go

@@ -6,18 +6,22 @@ import (
 	"path/filepath"
 )
 
-var ErrCacheUninitialized = errors.New("the route cache is uninitialized")
+var (
+	ErrCacheUninitialized       = errors.New("the route cache is uninitialized")
+	ErrFailedToCreateRouteCache = errors.New("failed to create route cache")
+	ErrRouterNotCreated         = errors.New("router not created")
+)
 
 type ErrRouteNotFound struct {
-	n string
+	route string
+}
+
+func NewErrRouteNotFound(route string) error {
+	return &ErrRouteNotFound{route: route}
 }
 
 func (e ErrRouteNotFound) Error() string {
-	return "route not found: " + string(e.n)
-}
-
-func NewErrRouteNotFound(n string) error {
-	return &ErrRouteNotFound{n: n}
+	return "route not found: " + string(e.route)
 }
 
 type ErrBadgerInit struct {
@@ -25,6 +29,10 @@ type ErrBadgerInit struct {
 	subDir  string
 }
 
+func NewErrBadgerInit(baseDir, subDir string) error {
+	return &ErrBadgerInit{baseDir: baseDir, subDir: subDir}
+}
+
 func (e ErrBadgerInit) Error() string {
 	if e.subDir == "" {
 		return fmt.Sprintf("failed to initialize badger store at base directory: %s", e.baseDir)
@@ -33,6 +41,19 @@ func (e ErrBadgerInit) Error() string {
 	return fmt.Sprintf("failed to initialize badger store at directory: %s", filepath.Join(e.baseDir, e.subDir))
 }
 
-func NewErrBadgerInit(baseDir, subDir string) error {
-	return &ErrBadgerInit{baseDir: baseDir, subDir: subDir}
+type WrappedErr struct {
+	e    error
+	with error
+}
+
+func Wrap(e, with error) WrappedErr {
+	return WrappedErr{e: e, with: with}
+}
+
+func (e WrappedErr) Error() string {
+	return fmt.Sprintf(`%s: %s`, e.e, e.with)
+}
+
+func (e WrappedErr) Unwrap() error {
+	return e.e
 }

internal/route_cache.go

@@ -1,135 +0,0 @@
-package internal
-
-import (
-	"context"
-	"fmt"
-	"log"
-	"net/http"
-	"regexp"
-	"strings"
-	"sync"
-	"time"
-
-	ee "git.markbailey.dev/cerbervs/joist/internal/errors"
-	"github.com/go-chi/chi/v5"
-)
-
-const suff = "route_cache"
-
-type RouteCacher interface {
-	Store(string, string) error
-	GetPath(string) (string, error)
-	All() (map[string]string, error)
-}
-
-type routeCache struct {
-	rx chi.Router
-	rs map[string]string
-	s  Storer
-}
-
-var (
-	rcLock sync.Mutex
-	rcOnce sync.Once
-	c      *routeCache
-)
-
-func NewRouteCache(store Storer, router chi.Router) (*routeCache, error) {
-	rcOnce.Do(func() {
-		if store == nil {
-			st, err := NewBadgerStore(WithSubDir("route_cache"))
-			if err != nil {
-				log.Println(err)
-				return
-			}
-
-			store = st
-		}
-
-		c = &routeCache{
-			rx: router,
-			rs: make(map[string]string),
-			s:  store,
-		}
-	})
-
-	if c == nil {
-		return nil, ee.ErrCacheUninitialized
-	}
-
-	rcLock.Lock()
-	defer rcLock.Unlock()
-
-	return c, nil
-}
-
-func (r *routeCache) All() (map[string]string, error) {
-	if r.rs == nil {
-		return nil, ee.ErrCacheUninitialized
-	}
-	return r.rs, nil
-}
-
-func (r *routeCache) Store(name string, path string) error {
-	return nil
-}
-
-func (r *routeCache) GetPath(name string) (string, error) {
-	if path, ok := r.rs[name]; ok {
-		return path, nil
-	}
-
-	return string(""), ee.NewErrRouteNotFound(string(name))
-}
-
-func (r *routeCache) UnmarshallFromStore() error {
-	if err := chi.Walk(r.rx, walker(r.s)); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func walker(store Storer) chi.WalkFunc {
-	ctx, cancel := context.WithCancel(context.Background())
-	defer cancel()
-
-	return func(method string, route string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) error {
-		routeName, err := convertRouteToRouteName(route)
-		if err != nil {
-			return fmt.Errorf(`failed to name route "%s"`, route)
-		}
-
-		if routeName[len(routeName)-2:] != ".*" {
-			route = regexp.MustCompile(`:.*}`).ReplaceAllString(route, "}")
-			if len(route) > 1 {
-				route = strings.TrimRight(route, "/")
-			}
-			store.Put(ctx, routeName, []byte(route), 1*time.Hour)
-		}
-
-		return nil
-	}
-}
-
-func convertRouteToRouteName(route string) (string, error) {
-	name := "app"
-	if route == "/" {
-		return name + ".home", nil
-	}
-
-	route = strings.ReplaceAll(route, "/", ".")
-	route = strings.ReplaceAll(route, "-", "_")
-
-	paramRegex := regexp.MustCompile(`\.{[^}]*}`)
-	params := paramRegex.FindAllString(route, -1)
-	route = paramRegex.ReplaceAllString(route, "")
-
-	if len(params) > 0 {
-		route += ".params"
-	}
-
-	name += strings.TrimRight(route, ".")
-
-	return name, nil
-}

middleware/middleware.go

@@ -0,0 +1,7 @@
+package middleware
+
+import "net/http"
+
+type Handler func(w http.ResponseWriter, r *http.Request) error
+
+type Middleware func(Handler) Handler

route_cache.go

@@ -0,0 +1,150 @@
+package joist
+
+import (
+	"context"
+	"errors"
+	"log"
+	"sync"
+	"time"
+
+	"git.markbailey.dev/cerbervs/joist/internal/badger"
+	jerr "git.markbailey.dev/cerbervs/joist/internal/errors"
+)
+
+type routeCache struct {
+	rs  map[string]string
+	ris map[string]*RouteInfo
+	s   Storer
+	ttl time.Duration
+}
+
+type RouteCacheOpt func(*routeCache)
+
+var (
+	rcOnce sync.Once
+	cache  *routeCache
+)
+
+func WithTTL(ttl time.Duration) RouteCacheOpt {
+	return func(r *routeCache) {
+		r.ttl = ttl
+	}
+}
+
+func WithStore(store Storer) RouteCacheOpt {
+	return func(r *routeCache) {
+		r.s = store
+	}
+}
+
+func NewRouteCacheService(opts ...RouteCacheOpt) (*routeCache, error) {
+	rcOnce.Do(func() {
+		c, err := newRouteCache(opts...)
+		if err != nil {
+			log.Fatal(err)
+		}
+
+		cache = c
+	})
+
+	if cache == nil {
+		return nil, jerr.ErrCacheUninitialized
+	}
+
+	return cache, nil
+}
+
+func (r *routeCache) All() (map[string]string, error) {
+	if r.rs == nil {
+		return nil, jerr.ErrCacheUninitialized
+	}
+	return r.rs, nil
+}
+
+func (r *routeCache) Add(name string, path string) error {
+	ttl := r.ttl
+	if ttl == 0 {
+		ttl = 1 * time.Hour
+	}
+
+	if err := r.s.Put(context.Background(), name, []byte(path), ttl); err != nil {
+		return err
+	}
+
+	r.rs[name] = path
+
+	return nil
+}
+
+func (r *routeCache) GetPath(name string) (string, error) {
+	if path, ok := r.rs[name]; ok {
+		return path, nil
+	}
+
+	if path, err := r.s.Get(context.Background(), name); err == nil {
+		return string(path), nil
+	}
+
+	return "", errors.New("route not found in cache")
+}
+
+func (r *routeCache) AddRouteInfo(routeInfo RouteInfo) error {
+	ttl := r.ttl
+	if ttl == 0 {
+		ttl = 1 * time.Hour
+	}
+
+	if err := r.s.Put(context.Background(), routeInfo.Name+":method", []byte(routeInfo.Method), ttl); err != nil {
+		return err
+	}
+	if err := r.s.Put(context.Background(), routeInfo.Name+":path", []byte(routeInfo.Path), ttl); err != nil {
+		return err
+	}
+	if err := r.s.Put(context.Background(), routeInfo.Name+":description", []byte(routeInfo.Description), ttl); err != nil {
+		return err
+	}
+	if err := r.s.Put(context.Background(), routeInfo.Name+":title", []byte(routeInfo.Title), ttl); err != nil {
+		return err
+	}
+
+	r.rs[routeInfo.Name] = routeInfo.Path
+	r.ris[routeInfo.Name] = &routeInfo
+
+	return nil
+}
+
+func (r *routeCache) GetRouteInfo(name string) (RouteInfo, error) {
+	if ri, ok := r.ris[name]; ok {
+		return *ri, nil
+	}
+
+	if info, err := r.s.GetForPrefix(context.Background(), name); err == nil {
+		return RouteInfo{
+			Method:      string(info[":method"]),
+			Name:        name,
+			Path:        string(info[":path"]),
+			Description: string(info[":description"]),
+			Title:       string(info[":title"]),
+		}, nil
+	}
+
+	return RouteInfo{}, errors.New("route info not found in cache")
+}
+
+func newRouteCache(opts ...RouteCacheOpt) (*routeCache, error) {
+	s, err := badger.NewBadgerStore(badger.WithSubDir("route_cache"))
+	if err != nil {
+		return nil, jerr.Wrap(jerr.ErrFailedToCreateRouteCache, err)
+	}
+
+	cache := &routeCache{
+		rs: make(map[string]string),
+		s:  s,
+	}
+
+	for _, opt := range opts {
+		opt(cache)
+	}
+
+	return cache, nil
+}

route_cache_test.go

@@ -1,4 +1,4 @@
-package internal
+package joist
 
 import "testing"
 

routing.go

@@ -0,0 +1,92 @@
+package joist
+
+import (
+	"context"
+	"log"
+	"net/http"
+	"regexp"
+	"strings"
+	"time"
+
+	jerr "git.markbailey.dev/cerbervs/joist/internal/errors"
+	"github.com/go-chi/chi/v5"
+)
+
+type RouteInfo struct {
+	Method      string
+	Name        string
+	Path        string
+	Description string
+	Title       string
+}
+
+func NewRouteInfo(method, path, description, title string) (RouteInfo, error) {
+	name, err := convertRouteToRouteName(path)
+	if err != nil {
+		return RouteInfo{}, err
+	}
+
+	return RouteInfo{
+		Method:      method,
+		Name:        name,
+		Path:        path,
+		Description: description,
+		Title:       title,
+	}, nil
+}
+
+type routeInfoKey struct{}
+
+type Router struct {
+	chi.Mux
+	cache    RouteCacher
+	cacheTTL time.Duration
+}
+
+func NewRouter() Router {
+	ttl := 8 * time.Hour
+
+	cache, err := NewRouteCacheService(WithTTL(ttl))
+	if err != nil {
+		log.Fatal(jerr.Wrap(err, jerr.ErrRouterNotCreated))
+	}
+
+	return Router{cache: cache, cacheTTL: ttl}
+}
+
+func (ro *Router) WithRouteInfo(ri RouteInfo, h HandlerFn) http.HandlerFunc {
+	ro.cache.AddRouteInfo(ri)
+
+	return func(w http.ResponseWriter, r *http.Request) {
+		ctx := context.WithValue(r.Context(), routeInfoKey{}, ri)
+		h.ServeHTTP(w, r.WithContext(ctx))
+	}
+}
+
+// TODO: move to base handler when it's implemented
+func GetRouteInfo(r *http.Request) (RouteInfo, bool) {
+	info, ok := r.Context().Value(routeInfoKey{}).(RouteInfo)
+	return info, ok
+}
+
+func convertRouteToRouteName(route string) (string, error) {
+	name := "app"
+	if route == "/" {
+		return name + ".home", nil
+	}
+
+	route = strings.ReplaceAll(route, "/", ".")
+	route = strings.ReplaceAll(route, "-", "_")
+
+	paramRegex := regexp.MustCompile(`\.{[^}]*}`)
+	params := paramRegex.FindAllString(route, -1)
+	route = paramRegex.ReplaceAllString(route, "")
+
+	if len(params) > 0 {
+		route += ".params"
+	}
+
+	name += strings.TrimRight(route, ".")
+
+	return name, nil
+}