11 Commits

Author SHA1 Message Date
5fc1b55d52 update 2025-08-09 19:05:21 +02:00
9718a027e0 use lru for client side cache 2025-08-07 13:58:39 +02:00
2377fb191a use lru for client side cache 2025-08-07 13:57:10 +02:00
6f7c7c5ea7 client side cache 2025-08-07 11:04:44 +02:00
474de0734f up 2025-08-07 10:27:43 +02:00
181e33db92 up 2025-08-06 20:59:33 +02:00
1e382f1552 up 2025-08-06 20:53:57 +02:00
4150ebe27c up 2025-08-06 20:50:31 +02:00
68ef0fbf6b up 2025-08-06 20:28:19 +02:00
17a9c5835e up 2025-08-06 19:31:38 +02:00
b8766e37c1 up 2025-08-06 18:19:40 +02:00
6 changed files with 136 additions and 52 deletions

7
LICENSE Normal file
View File

@@ -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.

View File

@@ -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.maxCacheSize = 100000 // or make this configurable
cli.maxCacheInitialLoad = 10000
cli.cacheMap, err = lru.New(cli.maxCacheSize)
if err != nil {
return nil, err
}
// 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() {
payload := map[string]string{
"id": shortID,
"url": longURL,
}
data, _ := json.Marshal(payload)
// Queue job
go c.enqueueJob(shortenJob{
ID: shortID,
URL: longURL,
})
req, err := http.NewRequest("POST", fmt.Sprintf("%s/shorten", c.serverURL), bytes.NewReader(data))
if err != nil {
log.Println("shorten request build error:", err)
return
// Async store in cache
if options.useCache {
go c.addToCache(longURL, shortID)
}
req.Header.Set("Content-Type", "application/json")
resp, err := c.httpClient.Do(req)
if err != nil {
log.Println("shorten request failed:", err)
return
}
defer resp.Body.Close()
}()
return fmt.Sprintf("%s/%s", c.domain, shortID)
return shortID
}
func (c *Client) addToCache(longURL, shortID string) {
c.cacheMap.Add(longURL, shortID)
// Async write to BoltDB
go func() {
_ = c.db.Update(func(tx *bolt.Tx) error {
b := tx.Bucket([]byte("url_cache"))
return b.Put([]byte(longURL), []byte(shortID))
})
}()
}

16
pkg/client/global.go Normal file
View File

@@ -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
}

View File

@@ -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 {
Prefix uint16 `json:"prefix"`
}
if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
bytes, err := io.ReadAll(resp.Body)
if 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{
"id": job.ID,
"url": job.URL,
}
data, _ := json.Marshal(payload)
req, err := http.NewRequest("POST", fmt.Sprintf("%s/shorten", c.serverURL), bytes.NewReader(data))
req, err := http.NewRequest("POST", fmt.Sprintf("%s/shorten?s=%s", c.serverURL, job.ID), strings.NewReader(job.URL))
if err != nil {
return err
}
req.Header.Set("Content-Type", "application/json")
resp, err := c.httpClient.Do(req)
if err != nil {
return err

View File

@@ -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())
return s.storage.Put(shortUrl, longUrl)
shortUrl := c.Query("s")
if shortUrl == "" {
shortUrl = s.serverGen.NextID()
}
err := s.storage.Put(shortUrl, longUrl)
if err != nil {
return err
}
return c.SendString(shortUrl)
})
return a

View File

@@ -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{