use lru for client side cache

.gitignore

@@ -1,2 +1,2 @@
 data/
-./shortify/
+shortify/

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Tijl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

examples/main.go

@@ -1,7 +1,10 @@
 package main
 
 import (
+	"fmt"
+
 	"git.tijl.dev/tijl/shortify"
+	"git.tijl.dev/tijl/shortify/pkg/generation"
 	"github.com/gofiber/fiber/v2"
 )
 
@@ -13,6 +16,9 @@ func main() {
 		panic(err)
 	}
 
+	// example decoding
+	fmt.Println(generation.DecodeBase62("11uPoqA1W"))
+
 	// listen the admin interface
 
 	unixListener, err := shortify.GetUnixListener("./shortify/admin.sock")

pkg/client/client.go

@@ -1,15 +1,13 @@
 package client
 
 import (
-	"bytes"
 	"encoding/binary"
-	"encoding/json"
 	"fmt"
-	"log"
 	"net/http"
 	"time"
 
 	"git.tijl.dev/tijl/shortify/pkg/generation"
+	lru "github.com/hashicorp/golang-lru"
 	bolt "go.etcd.io/bbolt"
 )
 
@@ -18,21 +16,25 @@ type Client struct {
 	httpClient *http.Client
 	prefix     uint16
 	gen        *generation.Generator
-	domain     string // e.g. https://sho.rt
 
 	db         *bolt.DB
 	retryQueue chan shortenJob
 	stopRetry  chan struct{}
+
+	// In-memory cache
+	cacheMap            *lru.Cache
+	maxCacheSize        int
+	maxCacheInitialLoad int
 }
 
 // NewClient with persistence and retry queue
-func NewClient(serverURL, domain string) (*Client, error) {
+func NewClient(serverURL string, folder string) (*Client, error) {
 	httpClient, baseURL, err := createHTTPClient(serverURL)
 	if err != nil {
 		return nil, err
 	}
 
-	db, err := bolt.Open(dbFileName, 0600, &bolt.Options{Timeout: 1 * time.Second})
+	db, err := bolt.Open(folder+"/"+dbFileName, 0600, &bolt.Options{Timeout: 1 * time.Second})
 	if err != nil {
 		return nil, err
 	}
@@ -40,12 +42,18 @@ func NewClient(serverURL, domain string) (*Client, error) {
 	cli := &Client{
 		serverURL:  baseURL,
 		httpClient: httpClient,
-		domain:     domain,
 		db:         db,
 		retryQueue: make(chan shortenJob, 1000),
 		stopRetry:  make(chan struct{}),
 	}
 
+	cli.cacheMap, err = lru.New(cli.maxCacheSize)
+	if err != nil {
+		return nil, err
+	}
+	cli.maxCacheSize = 100000 // or make this configurable
+	cli.maxCacheInitialLoad = 10000
+
 	// Create buckets if not exist
 	err = db.Update(func(tx *bolt.Tx) error {
 		_, err := tx.CreateBucketIfNotExists([]byte(bucketPrefix))
@@ -53,7 +61,16 @@ func NewClient(serverURL, domain string) (*Client, error) {
 			return err
 		}
 		_, err = tx.CreateBucketIfNotExists([]byte(bucketRetryJobs))
+		if err != nil {
 			return err
+		}
+
+		_, err = tx.CreateBucketIfNotExists([]byte(bucketURLCache))
+		if err != nil {
+			return err
+		}
+
+		return nil
 	})
 	if err != nil {
 		return nil, err
@@ -96,6 +113,21 @@ func NewClient(serverURL, domain string) (*Client, error) {
 	cli.prefix = prefix
 	cli.gen = generation.NewGenerator(prefix)
 
+	// load cache
+	_ = cli.db.View(func(tx *bolt.Tx) error {
+		b := tx.Bucket([]byte("url_cache"))
+		if b == nil {
+			return nil
+		}
+		c := b.Cursor()
+		initalCounter := 0
+		for k, v := c.First(); k != nil && initalCounter < cli.maxCacheInitialLoad; k, v = c.Next() {
+			cli.cacheMap.Add(string(k), string(v))
+			initalCounter++
+		}
+		return nil
+	})
+
 	// Load retry jobs from DB into channel
 	go cli.loadRetryJobs()
 
@@ -105,31 +137,60 @@ func NewClient(serverURL, domain string) (*Client, error) {
 	return cli, nil
 }
 
-// Shorten creates a short URL and sends it async to the central server
+/*
-func (c *Client) Shorten(longURL string) string {
+Shorten
+*/
+
+type ShortenOpt func(*shortenOptions)
+
+type shortenOptions struct {
+	useCache bool
+}
+
+func UseCache() ShortenOpt {
+	return func(opts *shortenOptions) {
+		opts.useCache = true
+	}
+}
+
+func (c *Client) Shorten(longURL string, opts ...ShortenOpt) string {
+	options := shortenOptions{}
+	for _, opt := range opts {
+		opt(&options)
+	}
+
+	// Check memory cache
+	if options.useCache {
+		if shortID, ok := c.cacheMap.Get(longURL); ok {
+			return shortID.(string)
+		}
+	}
+
+	// Generate new ID
 	shortID := c.gen.NextID()
 
-	go func() {
+	// Queue job
-		payload := map[string]string{
+	go c.enqueueJob(shortenJob{
-			"id":  shortID,
+		ID:  shortID,
-			"url": longURL,
+		URL: longURL,
-		}
+	})
-		data, _ := json.Marshal(payload)
 
-		req, err := http.NewRequest("POST", fmt.Sprintf("%s/shorten", c.serverURL), bytes.NewReader(data))
+	// Async store in cache
-		if err != nil {
+	if options.useCache {
-			log.Println("shorten request build error:", err)
+		go c.addToCache(longURL, shortID)
-			return
 	}
-		req.Header.Set("Content-Type", "application/json")
 
-		resp, err := c.httpClient.Do(req)
+	return shortID
-		if err != nil {
+}
-			log.Println("shorten request failed:", err)
+
-			return
+func (c *Client) addToCache(longURL, shortID string) {
-		}
+	c.cacheMap.Add(longURL, shortID)
-		defer resp.Body.Close()
+
-	}()
+	// Async write to BoltDB
-
+	go func() {
-	return fmt.Sprintf("%s/%s", c.domain, shortID)
+		_ = c.db.Update(func(tx *bolt.Tx) error {
+			b := tx.Bucket([]byte("url_cache"))
+			return b.Put([]byte(longURL), []byte(shortID))
+		})
+	}()
 }

pkg/client/global.go

@@ -0,0 +1,16 @@
+package client
+
+import "sync"
+
+var (
+	Global *Client
+	once   sync.Once
+)
+
+func Init(serverURL string, folder string) error {
+	var err error
+	once.Do(func() {
+		Global, err = NewClient(serverURL, folder)
+	})
+	return err
+}

pkg/client/store.go

@@ -1,11 +1,13 @@
 package client
 
 import (
-	"bytes"
+	"encoding/binary"
 	"encoding/json"
 	"fmt"
+	"io"
 	"log"
 	"net/http"
+	"strings"
 	"time"
 
 	bolt "go.etcd.io/bbolt"
@@ -14,6 +16,7 @@ import (
 const (
 	bucketPrefix    = "prefix"
 	bucketRetryJobs = "retry_queue"
+	bucketURLCache  = "url_cache"
 	dbFileName      = "shorty_client.db"
 )
 
@@ -23,19 +26,18 @@ type shortenJob struct {
 }
 
 func (c *Client) registerPrefix() (uint16, error) {
-	resp, err := c.httpClient.Post(fmt.Sprintf("%s/register", c.serverURL), "application/json", nil)
+	resp, err := c.httpClient.Get(fmt.Sprintf("%s/register", c.serverURL))
 	if err != nil {
 		return 0, err
 	}
 	defer resp.Body.Close()
 
-	var result struct {
+	bytes, err := io.ReadAll(resp.Body)
-		Prefix uint16 `json:"prefix"`
+	if err != nil {
-	}
-	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
 		return 0, err
 	}
-	return result.Prefix, nil
+
+	return binary.LittleEndian.Uint16(bytes), nil
 }
 
 func (c *Client) loadRetryJobs() {
@@ -108,18 +110,10 @@ func (c *Client) deleteJobFromDB(job shortenJob) {
 }
 
 func (c *Client) sendShortenJob(job shortenJob) error {
-	payload := map[string]string{
+	req, err := http.NewRequest("POST", fmt.Sprintf("%s/shorten?s=%s", c.serverURL, job.ID), strings.NewReader(job.URL))
-		"id":  job.ID,
-		"url": job.URL,
-	}
-	data, _ := json.Marshal(payload)
-
-	req, err := http.NewRequest("POST", fmt.Sprintf("%s/shorten", c.serverURL), bytes.NewReader(data))
 	if err != nil {
 		return err
 	}
-	req.Header.Set("Content-Type", "application/json")
-
 	resp, err := c.httpClient.Do(req)
 	if err != nil {
 		return err

pkg/generation/generation.go

@@ -7,10 +7,10 @@ import (
 )
 
 const (
-	idSize      = 4                   // 4 bytes for random part
+	idSize      = 6                   // 4 bytes for random part
 	prefixSize  = 2                   // 2 bytes for client prefix
 	rawIDLength = prefixSize + idSize // total 6 bytes
-	base62Len   = 8                   // 6 bytes encoded in base62 ~ 8 chars
+	//base62Len   = 8                   // 6 bytes encoded in base62 ~ 8 chars
 	poolSize = 10000
 )
 

serve.go

@@ -16,16 +16,22 @@ func (s *Server) Admin() *fiber.App {
 		if err != nil {
 			return err
 		}
-		var response []byte
+		response := make([]byte, 2)
 		binary.LittleEndian.PutUint16(response, prefix)
 		return c.Send(response)
 	})
 
 	a.Post("/shorten", func(c *fiber.Ctx) error {
-		shortUrl := c.Query("s")
 		longUrl := string(c.Body())
-
+		shortUrl := c.Query("s")
-		return s.storage.Put(shortUrl, longUrl)
+		if shortUrl == "" {
+			shortUrl = s.serverGen.NextID()
+		}
+		err := s.storage.Put(shortUrl, longUrl)
+		if err != nil {
+			return err
+		}
+		return c.SendString(shortUrl)
 	})
 
 	return a

server.go

@@ -38,7 +38,7 @@ func (s *Server) HandleGetURL() func(*fiber.Ctx) error {
 
 		url, err := s.GetURL(shortID)
 		if err != nil {
-			return err
+			return c.Next()
 		}
 
 		s.LogVisit(VisitLog{