Update 'README.md'

.air.toml

@@ -0,0 +1,37 @@
+root = "."
+testdata_dir = "testdata"
+tmp_dir = "tmp"
+
+[build]
+  args_bin = []
+  bin = "./tmp/main"
+  cmd = "go build -o ./tmp/main ."
+  delay = 1000
+  exclude_dir = ["assets", "tmp", "vendor", "testdata"]
+  exclude_file = []
+  exclude_regex = ["_test.go"]
+  exclude_unchanged = false
+  follow_symlink = false
+  full_bin = ""
+  include_dir = []
+  include_ext = ["go", "tpl", "tmpl", "html"]
+  kill_delay = "0s"
+  log = "build-errors.log"
+  send_interrupt = false
+  stop_on_error = true
+
+[color]
+  app = ""
+  build = "yellow"
+  main = "magenta"
+  runner = "green"
+  watcher = "cyan"
+
+[log]
+  time = false
+
+[misc]
+  clean_on_exit = false
+
+[screen]
+  clear_on_rebuild = false

.docker/prometheus/alert.yml

@@ -0,0 +1,6 @@
+groups:
+  - name: DemoAlerts
+    rules:
+      - alert: InstanceDown 
+        expr: up{job="services"} < 1 
+        for: 5m

.docker/prometheus/prometheus.yml

@@ -0,0 +1,17 @@
+global:
+  scrape_interval: 30s
+  scrape_timeout: 10s
+
+rule_files:
+  - alert.yml
+
+scrape_configs:
+  - job_name: services
+    metrics_path: /metrics
+    static_configs:
+      - targets:
+          - 'prometheus:9090'
+  - job_name: 'file_ds'
+    file_sd_configs:
+    - files:
+      - targets.json

.docker/prometheus/targets.json

@@ -0,0 +1,10 @@
+[
+    {
+        "targets": [
+            "api:9091"
+        ],
+        "labels": {
+            "job": "5f11-api"
+        }
+    }
+]

.gitignore

@@ -23,3 +23,4 @@ go.work
 
 # Artefacts
 5feet11
+tmp

5feet11.api

@@ -8,30 +8,41 @@ info (
 
 type (
 	ExpandReq {
-		Snowflake string `path:"snowflake"`
+		ID string `path:"id"`
 	}
 
 	ExpandResp {
-		RedirectUrl string `json:"redirectUrl"`
+		LongUrl string `json:"longUrl"`
 	}
 )
 
 type (
 	ShortenReq {
-		RedirectUrl string `json:"redirectUrl"`
-		Secret      string `json:"secret,optional"`
-		ExpiresIn   int64  `json:"expiresIn,optional"`
+		LongUrl      string `json:"longUrl"`
+		ExpiresAfter int64  `json:"expiresAfter,optional"`
 	}
 
 	ShortenResp {
-		Id string `json:"id"`
+		ID string `json:"id"`
+	}
+)
+
+type (
+	GetLinkResp {
+		ID        string `json:"id"`
+		LongUrl   string `json:"longUrl"`
+		CreatedAt string `json:"createdAt"`
+		Lifespan  int64  `json:"lifespan"`
 	}
 )
 
 service fivefeeteleven-api {
 	@handler ExpandUrl
-	get /:snowflake(ExpandReq) returns(ExpandResp)
+	get /:id(ExpandReq) returns(ExpandResp)
 	
 	@handler ShortenUrl
-	post /redirect(ShortenReq) returns(ShortenResp)
+	post /api/v1/links(ShortenReq) returns(ShortenResp)
+	
+	@handler GetLink
+	get /api/v1/links/:id(ExpandReq) returns(GetLinkResp)
 }

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:alpine AS builder
+FROM golang:1.19-alpine AS builder
 
 LABEL stage=gobuilder
 
@@ -19,8 +19,8 @@ RUN go build -ldflags="-s -w" -o /app/5feet11 .
 FROM scratch
 
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt
-COPY --from=builder /usr/share/zoneinfo/Europe/Amsterdam /usr/share/zoneinfo/Europe/Amsterdam
-ENV TZ Europe/Amsterdam
+COPY --from=builder /usr/share/zoneinfo/Etc/UTC /usr/share/zoneinfo/Etc/UTC
+ENV TZ Etc/UTC
 
 WORKDIR /app
 COPY --from=builder /app/5feet11 /app/5feet11

README.md

@@ -1,15 +1,39 @@
 # 5feet11
 
-A URL shortener that generates links even shorter than 5'11.
+A scalable URL shortener.
+
+## Prepare
+- ScyllaDB
+- Prometheus*
+
+*: Optional
+
+## Run
+Update the config at `etc/fivefeeteleven-api.yaml`.
+```sh
+# Docker
+docker run -it $(docker build -q .)
+
+# Compile
+make build && ./5feet11
+```
+
 
 ## Usage
 ```bash
 # Shorten a URL
-curl --header "Content-Type: application/json" \
-  --request POST \
-  --data '{"redirectUrl":"https://news.ycombinator.com"}' \
-  http://localhost:5111/redirect
+curl -X POST -H "Content-Type: application/json" \
+  -d '{"longUrl":"https://news.ycombinator.com"}' \
+  http://localhost:5111/api/v1/links
+
+# Shorten a URL that expires after N seconds
+curl -X POST -H "Content-Type: application/json" \
+  -d '{"longUrl":"https://news.ycombinator.com", "expiresAfter": 30}' \
+  http://localhost:5111/api/v1/links
 
 # Expand the URL
 curl -iL http://localhost:5111/{id}
+
+# Get information of a specific URL
+curl -iL http://localhost:5111/api/v1/links/{id}
 ```

docker-compose.dev.yml

@@ -0,0 +1,22 @@
+version: '3'
+
+services:
+  scylla:
+    image: scylladb/scylla
+    ports:
+      - 7000:7000
+      - 7001:7001
+      - 9042:9042
+      - 9160:9160
+      - 10000:10000
+  prometheus:
+    image: prom/prometheus:v2.30.3
+    ports:
+      - 9090:9090
+    volumes:
+      - .docker/prometheus:/etc/prometheus
+      - prometheus-data:/prometheus
+    command: --web.enable-lifecycle  --config.file=/etc/prometheus/prometheus.yml
+
+volumes:
+  prometheus-data:

docker-compose.yml

@@ -1,11 +0,0 @@
-version: '3'
-
-services:
-  scylla:
-    image: scylladb/scylla
-    ports:
-      - "7000:7000"
-      - "7001:7001"
-      - "9042:9042"
-      - "9160:9160"
-      - "10000:10000"

etc/fivefeeteleven-api.yaml

@@ -4,4 +4,8 @@ Host: 0.0.0.0
 Port: 5111
 ScyllaDB:
   Hosts:
-    - "localhost"
+    - localhost
+# Prometheus:
+#   Host: 0.0.0.0
+#   Port: 9091
+#   Path: /metrics

fivefeeteleven.go

@@ -2,14 +2,17 @@ package main
 
 import (
 	"flag"
+	"net/http"
 
 	"5feet11/internal/config"
+	"5feet11/internal/errorx"
 	"5feet11/internal/handler"
 	"5feet11/internal/svc"
 
 	"github.com/zeromicro/go-zero/core/conf"
 	"github.com/zeromicro/go-zero/core/logx"
 	"github.com/zeromicro/go-zero/rest"
+	"github.com/zeromicro/go-zero/rest/httpx"
 )
 
 var configFile = flag.String("f", "etc/fivefeeteleven-api.yaml", "the config file")
@@ -26,6 +29,15 @@ func main() {
 	ctx := svc.NewServiceContext(c)
 	handler.RegisterHandlers(server, ctx)
 
+	httpx.SetErrorHandler(func(err error) (int, interface{}) {
+		switch e := err.(type) {
+		case *errorx.CodeError:
+			return http.StatusBadRequest, e.Data()
+		default:
+			return http.StatusInternalServerError, nil
+		}
+	})
+
 	logx.Infof("Starting server at http://%s:%d", c.Host, c.Port)
 	server.Start()
 }

internal/db/models.go

@@ -1,16 +1,21 @@
 package db
 
-import "github.com/scylladb/gocqlx/v2/table"
+import (
+	"time"
+
+	"github.com/scylladb/gocqlx/v2/table"
+)
 
 var UrlTable = table.New(table.Metadata{
 	Name:    "fivefeeteleven.urls",
-	Columns: []string{"id", "redirect_url", "secret"},
+	Columns: []string{"id", "long_url", "lifespan", "created_at"},
 	PartKey: []string{"id"},
 	SortKey: []string{},
 })
 
 type UrlModel struct {
-	Id          string
-	RedirectUrl string
-	Secret      *string
+	ID        string
+	LongUrl   string
+	Lifespan  int64
+	CreatedAt time.Time
 }

internal/db/seed.go

@@ -15,8 +15,9 @@ func Seed(session gocqlx.Session) error {
 	err = session.ExecStmt(`
 		CREATE TABLE IF NOT EXISTS fivefeeteleven.urls (
 			id text PRIMARY KEY,
-			redirect_url text,
-			secret text
+			long_url text,
+			created_at timestamp,
+			lifespan bigint
 		)`)
 
 	if err != nil {

internal/errorx/http.go

@@ -0,0 +1,32 @@
+package errorx
+
+const defaultCode = 1001
+
+type CodeError struct {
+	Code int    `json:"code"`
+	Msg  string `json:"msg"`
+}
+
+type CodeErrorResponse struct {
+	Code int    `json:"code"`
+	Msg  string `json:"msg"`
+}
+
+func NewCodeError(code int, msg string) error {
+	return &CodeError{Code: code, Msg: msg}
+}
+
+func NewDefaultError(msg string) error {
+	return NewCodeError(defaultCode, msg)
+}
+
+func (e *CodeError) Error() string {
+	return e.Msg
+}
+
+func (e *CodeError) Data() *CodeErrorResponse {
+	return &CodeErrorResponse{
+		Code: e.Code,
+		Msg:  e.Msg,
+	}
+}

internal/handler/expandurlhandler.go

@@ -23,7 +23,7 @@ func ExpandUrlHandler(svcCtx *svc.ServiceContext) http.HandlerFunc {
 		if err != nil {
 			httpx.Error(w, err)
 		} else {
-			http.Redirect(w, r, resp.RedirectUrl, http.StatusTemporaryRedirect)
+			http.Redirect(w, r, resp.LongUrl, http.StatusTemporaryRedirect)
 		}
 	}
 }

internal/handler/getlinkhandler.go

@@ -0,0 +1,28 @@
+package handler
+
+import (
+	"net/http"
+
+	"5feet11/internal/logic"
+	"5feet11/internal/svc"
+	"5feet11/internal/types"
+	"github.com/zeromicro/go-zero/rest/httpx"
+)
+
+func GetLinkHandler(svcCtx *svc.ServiceContext) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		var req types.ExpandReq
+		if err := httpx.Parse(r, &req); err != nil {
+			httpx.Error(w, err)
+			return
+		}
+
+		l := logic.NewGetLinkLogic(r.Context(), svcCtx)
+		resp, err := l.GetLink(&req)
+		if err != nil {
+			httpx.Error(w, err)
+		} else {
+			httpx.OkJson(w, resp)
+		}
+	}
+}

internal/handler/routes.go

@@ -14,14 +14,19 @@ func RegisterHandlers(server *rest.Server, serverCtx *svc.ServiceContext) {
 		[]rest.Route{
 			{
 				Method:  http.MethodGet,
-				Path:    "/:snowflake",
+				Path:    "/:id",
 				Handler: ExpandUrlHandler(serverCtx),
 			},
 			{
 				Method:  http.MethodPost,
-				Path:    "/redirect",
+				Path:    "/api/v1/links",
 				Handler: ShortenUrlHandler(serverCtx),
 			},
+			{
+				Method:  http.MethodGet,
+				Path:    "/api/v1/links/:id",
+				Handler: GetLinkHandler(serverCtx),
+			},
 		},
 	)
 }

internal/logic/expandurllogic.go

@@ -2,9 +2,9 @@ package logic
 
 import (
 	"context"
-	"fmt"
 
 	"5feet11/internal/db"
+	"5feet11/internal/errorx"
 	"5feet11/internal/svc"
 	"5feet11/internal/types"
 
@@ -26,20 +26,20 @@ func NewExpandUrlLogic(ctx context.Context, svcCtx *svc.ServiceContext) *ExpandU
 }
 
 func (l *ExpandUrlLogic) ExpandUrl(req *types.ExpandReq) (resp *types.ExpandResp, err error) {
-	queryUrl := db.UrlTable.SelectBuilder("redirect_url").Query(l.svcCtx.DB)
-	queryUrl.BindStruct(db.UrlModel{Id: req.Snowflake})
+	queryUrl := db.UrlTable.SelectBuilder("long_url").Query(l.svcCtx.DB)
+	queryUrl.BindStruct(db.UrlModel{ID: req.ID})
 
 	var urls []db.UrlModel
 	if err := queryUrl.Select(&urls); err != nil {
-		return nil, err
+		return nil, errorx.NewDefaultError(err.Error())
 	}
 
 	if len(urls) != 1 {
-		return nil, fmt.Errorf("no URL found")
+		return nil, errorx.NewDefaultError("no URL found")
 	}
 
 	resp = &types.ExpandResp{
-		RedirectUrl: urls[0].RedirectUrl,
+		LongUrl: urls[0].LongUrl,
 	}
 
 	return resp, err

internal/logic/getlinklogic.go

@@ -0,0 +1,49 @@
+package logic
+
+import (
+	"context"
+
+	"5feet11/internal/db"
+	"5feet11/internal/errorx"
+	"5feet11/internal/svc"
+	"5feet11/internal/types"
+
+	"github.com/zeromicro/go-zero/core/logx"
+)
+
+type GetLinkLogic struct {
+	logx.Logger
+	ctx    context.Context
+	svcCtx *svc.ServiceContext
+}
+
+func NewGetLinkLogic(ctx context.Context, svcCtx *svc.ServiceContext) *GetLinkLogic {
+	return &GetLinkLogic{
+		Logger: logx.WithContext(ctx),
+		ctx:    ctx,
+		svcCtx: svcCtx,
+	}
+}
+
+func (l *GetLinkLogic) GetLink(req *types.ExpandReq) (resp *types.GetLinkResp, err error) {
+	queryUrl := db.UrlTable.SelectQuery(l.svcCtx.DB)
+	queryUrl.BindStruct(db.UrlModel{ID: req.ID})
+
+	var urls []db.UrlModel
+	if err := queryUrl.Select(&urls); err != nil {
+		return nil, errorx.NewDefaultError(err.Error())
+	}
+
+	if len(urls) != 1 {
+		return nil, errorx.NewDefaultError("no URL found")
+	}
+
+	resp = &types.GetLinkResp{
+		ID:        urls[0].ID,
+		LongUrl:   urls[0].LongUrl,
+		CreatedAt: urls[0].CreatedAt.String(),
+		Lifespan:  urls[0].Lifespan,
+	}
+
+	return resp, err
+}

internal/logic/shortenurllogic.go

@@ -5,6 +5,7 @@ import (
 	"time"
 
 	"5feet11/internal/db"
+	"5feet11/internal/errorx"
 	"5feet11/internal/svc"
 	"5feet11/internal/types"
 
@@ -27,20 +28,28 @@ func NewShortenUrlLogic(ctx context.Context, svcCtx *svc.ServiceContext) *Shorte
 
 func (l *ShortenUrlLogic) ShortenUrl(req *types.ShortenReq) (resp *types.ShortenResp, err error) {
 	id := l.svcCtx.Snowflake.Generate().Base58()
+	insertBuilder := db.UrlTable.InsertBuilder()
 
-	insertUrl := db.UrlTable.InsertBuilder().TTL(30 * time.Second).Query(l.svcCtx.DB)
+	logx.Info(req.ExpiresAfter)
+	if req.ExpiresAfter != 0 {
+		insertBuilder.TTL(time.Second * time.Duration(req.ExpiresAfter))
+	}
+
+	insertUrl := insertBuilder.Query(l.svcCtx.DB)
 	insertUrl.BindStruct(db.UrlModel{
-		Id:          id,
-		RedirectUrl: req.RedirectUrl,
-		Secret:      &req.Secret,
+		ID:        id,
+		LongUrl:   req.LongUrl,
+		Lifespan:  req.ExpiresAfter,
+		CreatedAt: time.Now(),
 	})
 
 	if err := insertUrl.ExecRelease(); err != nil {
-		return nil, err
+		return nil, errorx.NewDefaultError(err.Error())
 	}
 
 	resp = &types.ShortenResp{
-		Id: id,
+		ID: id,
 	}
+
 	return resp, nil
 }

internal/types/types.go

@@ -2,19 +2,25 @@
 package types
 
 type ExpandReq struct {
-	Snowflake string `path:"snowflake"`
+	ID string `path:"id"`
 }
 
 type ExpandResp struct {
-	RedirectUrl string `json:"redirectUrl"`
+	LongUrl string `json:"longUrl"`
 }
 
 type ShortenReq struct {
-	RedirectUrl string `json:"redirectUrl"`
-	Secret      string `json:"secret,optional"`
-	ExpiresIn   int64  `json:"expiresIn,optional"`
+	LongUrl      string `json:"longUrl"`
+	ExpiresAfter int64  `json:"expiresAfter,optional"`
 }
 
 type ShortenResp struct {
-	Id string `json:"id"`
+	ID string `json:"id"`
+}
+
+type GetLinkResp struct {
+	ID        string `json:"id"`
+	LongUrl   string `json:"longUrl"`
+	CreatedAt string `json:"createdAt"`
+	Lifespan  int64  `json:"lifespan"`
 }