Merge branch 'master' into admin_view

* master:
  configurable app DisplayURL for the UI (#121)
  use redis as a session store backend (#119)

Author: Jeff Billimek

config/example.yaml

@@ -1,5 +1,6 @@
 ListenAddr: ':8080' # Consists of 'IP:Port', e.g. ':8080' listens on any IP and on Port 8080
-BaseURL: 'http://localhost:3000' # Origin URL, required for the authentication via OAuth
+BaseURL: 'http://localhost:3000' # Origin URL, required for the authentication via OAuth callback
+DisplayURL: '' # (OPTIONAL) Display URL, how the apication will present itself in the UI - if not set, defaults to BaseURL
 Backend: boltdb # Can be 'boltdb' or 'redis'
 DataDir: ./data # Contains: the database and the private key
 EnableDebugMode: true # Activates more detailed logging
@@ -22,9 +23,11 @@ Proxy:  # only relevant when using the proxy authbackend
   UserHeader: "X-Goog-Authenticated-User-ID" # pull the unique user ID from this header
   DisplayNameHeader: "X-Goog-Authenticated-User-Email" # pull the display naem from this header
 Redis:
-  Host: localhost:6379 # host:port combination; required
-  Password: replace me # redis connection password; optional; default is none
-  Db: 0                # redis index (https://redis.io/commands/select); optional; default is 0
-  MaxRetries: 3        # maximum number of retries for a failed redis command
-  ReadTimeout: 3s      # timeout for read operations; default is 3s. This is a golang time.ParseDuration string
-  WriteTimeout: 3s     # timeout for write operations; default is 3s. This is a golang time.ParseDuration string
+  Host: localhost:6379  # host:port combination; required
+  Password: replace me  # redis connection password; optional; default is none
+  Db: 0                 # redis index (https://redis.io/commands/select); optional; default is 0
+  MaxRetries: 3         # maximum number of retries for a failed redis command
+  ReadTimeout: 3s       # timeout for read operations; default is 3s. This is a golang time.ParseDuration string
+  WriteTimeout: 3s      # timeout for write operations; default is 3s. This is a golang time.ParseDuration string
+  SessionDB: 1          # redis session store index (https://redis.io/commands/select); optional; default is 1
+  SharedKey: replace me # redis session store shared key; optional; default is "secret"

deployments/cloudfoundry/run.sh

@@ -13,6 +13,7 @@ fi
 if [ "$REDIS" != "" ]; then
     export GUS_REDIS_HOST="$(echo $VCAP_SERVICES | jq -r '.["'$REDIS_SERVICE_NAME'"][0].credentials.host'):$(echo $VCAP_SERVICES | jq -r '.["'$REDIS_SERVICE_NAME'"][0].credentials.port')"
     export GUS_REDIS_PASSWORD="$(echo $VCAP_SERVICES | jq -r '.["'$REDIS_SERVICE_NAME'"][0].credentials.password')"
+    export GUS_REDIS_SHARED_KEY=$GUS_REDIS_PASSWORD
 fi
 
 echo "#### Starting golang-url-shortener..."

internal/handlers/auth.go

@@ -9,14 +9,22 @@ import (
 	"github.com/sirupsen/logrus"
 
 	jwt "github.com/dgrijalva/jwt-go"
-	"github.com/gin-gonic/contrib/sessions"
+	"github.com/gin-contrib/sessions"
+	"github.com/gin-contrib/sessions/cookie"
+	"github.com/gin-contrib/sessions/redis"
 	"github.com/gin-gonic/gin"
 	"github.com/pkg/errors"
 )
 
 func (h *Handler) initOAuth() {
-	h.engine.Use(sessions.Sessions("backend", sessions.NewCookieStore(util.GetPrivateKey())))
-
+	switch backend := util.GetConfig().Backend; backend {
+	// use redis as the session store if it is configured
+	case "redis":
+		store, _ := redis.NewStoreWithDB(10, "tcp", util.GetConfig().Redis.Host, util.GetConfig().Redis.Password, util.GetConfig().Redis.SessionDB, util.GetPrivateKey())
+		h.engine.Use(sessions.Sessions("backend", store))
+	default:
+		h.engine.Use(sessions.Sessions("backend", cookie.NewStore(util.GetPrivateKey())))
+	}
 	h.providers = []string{}
 	google := util.GetConfig().Google
 	if google.Enabled() {
@@ -39,7 +47,14 @@ func (h *Handler) initOAuth() {
 
 // initProxyAuth intializes data structures for proxy authentication mode
 func (h *Handler) initProxyAuth() {
-	h.engine.Use(sessions.Sessions("backend", sessions.NewCookieStore(util.GetPrivateKey())))
+	switch backend := util.GetConfig().Backend; backend {
+	// use redis as the session store if it is configured
+	case "redis":
+		store, _ := redis.NewStoreWithDB(10, "tcp", util.GetConfig().Redis.Host, util.GetConfig().Redis.Password, util.GetConfig().Redis.SessionDB, util.GetPrivateKey())
+		h.engine.Use(sessions.Sessions("backend", store))
+	default:
+		h.engine.Use(sessions.Sessions("backend", cookie.NewStore(util.GetPrivateKey())))
+	}
 	h.providers = []string{}
 	h.providers = append(h.providers, "proxy")
 	h.engine.POST("/api/v1/auth/check", h.handleAuthCheck)

internal/handlers/auth/auth.go

@@ -8,7 +8,7 @@ import (
 	"time"
 
 	jwt "github.com/dgrijalva/jwt-go"
-	"github.com/gin-gonic/contrib/sessions"
+	"github.com/gin-contrib/sessions"
 	"github.com/gin-gonic/gin"
 	"github.com/mxschmitt/golang-url-shortener/internal/util"
 	"github.com/pkg/errors"

internal/handlers/handlers.go

@@ -164,6 +164,7 @@ func (h *Handler) setHandlers() error {
 	h.engine.GET("/api/v1/info", h.handleInfo)
 	h.engine.GET("/d/:id/:hash", h.handleDelete)
 	h.engine.GET("/ok", h.handleHealthcheck)
+	h.engine.GET("/displayurl", h.handleDisplayURL)
 
 	// Handling the shorted URLs, if no one exists, it checks
 	// in the filesystem and sets headers for caching

internal/handlers/public.go

@@ -162,6 +162,12 @@ func (h *Handler) handleInfo(c *gin.Context) {
 	c.JSON(http.StatusOK, out)
 }
 
+// handleDisplayURL returns the URL to use for display purposes
+func (h *Handler) handleDisplayURL(c *gin.Context) {
+	out := util.GetConfig().DisplayURL
+	c.JSON(http.StatusOK, out)
+}
+
 func (h *Handler) handleRecent(c *gin.Context) {
 	user := c.MustGet("user").(*auth.JWTClaims)
 	entries, err := h.store.GetUserEntries(user.OAuthProvider, user.OAuthID)

internal/util/config.go

@@ -16,6 +16,7 @@ import (
 type Configuration struct {
 	ListenAddr       string        `yaml:"ListenAddr" env:"LISTEN_ADDR"`
 	BaseURL          string        `yaml:"BaseURL" env:"BASE_URL"`
+	DisplayURL       string        `yaml:"DisplayURL" env:"DISPLAY_URL"`
 	DataDir          string        `yaml:"DataDir" env:"DATA_DIR"`
 	Backend          string        `yaml:"Backend" env:"BACKEND"`
 	AuthBackend      string        `yaml:"AuthBackend" env:"AUTH_BACKEND"`
@@ -38,6 +39,8 @@ type redisConf struct {
 	MaxRetries   int    `yaml:"MaxRetries" env:"MAX_RETRIES"`
 	ReadTimeout  string `yaml:"ReadTimeout" env:"READ_TIMEOUT"`
 	WriteTimeout string `yaml:"WriteTimeout" env:"WRITE_TIMEOUT"`
+	SessionDB    string `yaml:"SessionDB" env:"SESSION_DB"`
+	SharedKey    string `yaml:"SharedKey" env:"SHARED_KEY"`
 }
 
 type oAuthConf struct {
@@ -52,10 +55,11 @@ type proxyAuthConf struct {
 	DisplayNameHeader string `yaml:"DisplayNameHeader" env:"DISPLAY_NAME_HEADER"`
 }
 
-// config contains the default values
+// Config contains the default values
 var Config = Configuration{
 	ListenAddr:       ":8080",
 	BaseURL:          "http://localhost:3000",
+	DisplayURL:       "",
 	DataDir:          "data",
 	Backend:          "boltdb",
 	EnableDebugMode:  false,
@@ -69,6 +73,8 @@ var Config = Configuration{
 		MaxRetries:   3,
 		ReadTimeout:  "3s",
 		WriteTimeout: "3s",
+		SessionDB:    "1",
+		SharedKey:    "secret",
 	},
 }
 
@@ -106,6 +112,11 @@ func (o oAuthConf) Enabled() bool {
 
 // GetConfig returns the configuration from the memory
 func GetConfig() Configuration {
+	// if DisplayURL is not set in the config, default to BaseURL
+	if Config.DisplayURL == "" {
+		Config.DisplayURL = Config.BaseURL
+	}
+
 	return Config
 }
 

internal/util/private.go

@@ -35,5 +35,10 @@ func CheckForPrivateKey() error {
 
 // GetPrivateKey returns the private key
 func GetPrivateKey() []byte {
-	return privateKey
+	switch backend := GetConfig().Backend; backend {
+	case "redis":
+		return []byte(GetConfig().Redis.SharedKey)
+	default:
+		return privateKey
+	}
 }

web/src/Home/Home.js

@@ -18,7 +18,8 @@ export default class HomeComponent extends Component {
         usedSettings: this.urlParams.get('customUrl') ? ['custom'] : [],
         customID: this.urlParams.get('customUrl') ? this.urlParams.get('customUrl') : '',
         showCustomIDError: false,
-        expiration: null
+        expiration: null,
+        displayURL: window.location.origin
       }
   }
   handleURLChange = (e, { value }) => this.url = value
@@ -31,12 +32,13 @@ export default class HomeComponent extends Component {
   onSettingsChange = (e, { value }) => {
     this.setState({ usedSettings: value })
   }
-    
-  
 
-  
+
   componentDidMount() {
     this.urlInput.focus()
+    fetch("/displayurl")
+    .then(response => response.json())
+    .then(data => this.setState({displayURL: data}));
   }
   handleURLSubmit = () => {
     if (!this.state.showCustomIDError) {
@@ -47,7 +49,7 @@ export default class HomeComponent extends Component {
         Password: this.state.usedSettings.includes("protected") && this.password ? this.password : undefined
       }, r => this.setState({
         links: [...this.state.links, {
-          shortenedURL: r.URL,
+          shortenedURL: this.state.displayURL + "/" + this.state.customID,
           originalURL: this.url,
           expiration: this.state.usedSettings.includes("expire") && this.state.expiration ? this.state.expiration.toISOString() : undefined,
           deletionURL: r.DeletionURL
@@ -89,7 +91,7 @@ export default class HomeComponent extends Component {
             </MediaQuery>
             <Form.Group style={{ marginBottom: "1rem" }}>
               {usedSettings.includes("custom") && <Form.Field error={showCustomIDError} width={16}>
-                <Input label={window.location.origin + "/"} onChange={this.handleCustomIDChange} placeholder='my-shortened-url' value={this.state.customID}/>
+                <Input label={this.state.displayURL + "/"} onChange={this.handleCustomIDChange} placeholder='my-shortened-url' value={this.state.customID}/>
               </Form.Field>}
             </Form.Group>
             <Form.Group widths="equal">

web/src/Lookup/Lookup.js

@@ -6,15 +6,21 @@ import CustomCard from '../Card/Card'
 
 export default class LookupComponent extends Component {
     state = {
-        links: []
+        links: [],
+        displayURL: window.location.origin
+    }
+    componentDidMount() {
+        fetch("/displayurl")
+        .then(response => response.json())
+        .then(data => this.setState({displayURL: data}));
     }
     handleURLChange = (e, { value }) => this.url = value
     handleURLSubmit = () => {
-        let id = this.url.replace(window.location.origin + "/", "")
+        let id = this.url.replace(this.state.displayURL + "/", "")
         util.lookupEntry(id, res => this.setState({
             links: [...this.state.links, [
                 res.URL,
-                this.url,
+                this.state.displayURL + "/" + this.url,
                 this.VisitCount,
                 res.CratedOn,
                 res.LastVisit,
@@ -30,7 +36,7 @@ export default class LookupComponent extends Component {
                     <Header size='huge'>URL Lookup</Header>
                     <Form onSubmit={this.handleURLSubmit}>
                         <Form.Field>
-                            <Input required size='big' ref={input => this.urlInput = input} action={{ icon: 'arrow right', labelPosition: 'right', content: 'Lookup' }} type='url' onChange={this.handleURLChange} name='url' placeholder={window.location.origin + "/..."} autoComplete="off" />
+                            <Input required size='big' ref={input => this.urlInput = input} action={{ icon: 'arrow right', labelPosition: 'right', content: 'Lookup' }} type='text' label={this.state.displayURL + "/"} onChange={this.handleURLChange} name='url' placeholder={"short url"} autoComplete="off" />
                         </Form.Field>
                     </Form>
                 </Segment>