Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(logs): improve log abstraction #43

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(logs): improve log abstraction #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions _examples/cas-dumper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ import (
"net/http"
"net/url"

"github.com/golang/glog"

"gopkg.in/cas.v1"
"gopkg.in/cas.v2"
"gopkg.in/cas.v2/logs"
)

type myHandler struct{}
Expand All @@ -30,7 +29,7 @@ func main() {
return
}

glog.Info("Starting up")
logs.Info("Starting up")

m := http.NewServeMux()
m.Handle("/", MyHandler)
Expand All @@ -46,10 +45,10 @@ func main() {
}

if err := server.ListenAndServe(); err != nil {
glog.Infof("Error from HTTP Server: %v", err)
logs.Infof("Error from HTTP Server: %v", err)
}

glog.Info("Shutting down")
logs.Info("Shutting down")
}

type templateBinding struct {
Expand Down
58 changes: 15 additions & 43 deletions client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@ package cas

import (
"crypto/rand"
"fmt"
"net/http"
"net/url"

"github.com/golang/glog"
"gopkg.in/cas.v2/logs"
)

// Options : Client configuration options
Expand Down Expand Up @@ -35,9 +34,7 @@ type Client struct {

// NewClient creates a Client with the provided Options.
func NewClient(options *Options) *Client {
if glog.V(2) {
glog.Infof("cas: new client with options %v", options)
}
logs.Infof("cas: new client with options %v", options)

var tickets TicketStore
if options.Store != nil {
Expand Down Expand Up @@ -191,10 +188,8 @@ func (c *Client) RedirectToLogout(w http.ResponseWriter, r *http.Request) {
return
}

if glog.V(2) {
glog.Infof("Logging out, redirecting client to %v with status %v",
u, http.StatusFound)
}
logs.Infof("Logging out, redirecting client to %v with status %v",
u, http.StatusFound)

c.clearSession(w, r)
http.Redirect(w, r, u, http.StatusFound)
Expand All @@ -208,9 +203,7 @@ func (c *Client) RedirectToLogin(w http.ResponseWriter, r *http.Request) {
return
}

if glog.V(2) {
glog.Infof("Redirecting client to %v with status %v", u, http.StatusFound)
}
logs.Infof("Redirecting client to %v with status %v", u, http.StatusFound)

http.Redirect(w, r, u, http.StatusFound)
}
Expand Down Expand Up @@ -243,50 +236,36 @@ func (c *Client) getSession(w http.ResponseWriter, r *http.Request) {

if s, ok := c.sessions.Get(cookie.Value); ok {
if t, err := c.tickets.Read(s); err == nil {
if glog.V(1) {
glog.Infof("Re-used ticket %s for %s", s, t.User)
}
logs.Infof("Re-used ticket %s for %s", s, t.User)

setAuthenticationResponse(r, t)
return
} else {
if glog.V(2) {
glog.Infof("Ticket %v not in %T: %v", s, c.tickets, err)
}
logs.Infof("Ticket %v not in %T: %v", s, c.tickets, err)

if glog.V(1) {
glog.Infof("Clearing ticket %s, no longer exists in ticket store", s)
}
logs.Infof("Clearing ticket %s, no longer exists in ticket store", s)

clearCookie(w, cookie)
}
}

if ticket := r.URL.Query().Get("ticket"); ticket != "" {
if err := c.validateTicket(ticket, r); err != nil {
if glog.V(2) {
glog.Infof("Error validating ticket: %v", err)
}
logs.Infof("Error validating ticket: %v", err)
return // allow ServeHTTP()
}

c.setSession(cookie.Value, ticket)

if t, err := c.tickets.Read(ticket); err == nil {
if glog.V(1) {
glog.Infof("Validated ticket %s for %s", ticket, t.User)
}
logs.Infof("Validated ticket %s for %s", ticket, t.User)

setAuthenticationResponse(r, t)
return
} else {
if glog.V(2) {
glog.Infof("Ticket %v not in %T: %v", ticket, c.tickets, err)
}
logs.Infof("Ticket %v not in %T: %v", ticket, c.tickets, err)

if glog.V(1) {
glog.Infof("Clearing ticket %s, no longer exists in ticket store", ticket)
}
logs.Infof("Clearing ticket %s, no longer exists in ticket store", ticket)

clearCookie(w, cookie)
}
Expand All @@ -310,9 +289,7 @@ func (c *Client) getCookie(w http.ResponseWriter, r *http.Request) *http.Cookie
SameSite: c.cookie.SameSite,
}

if glog.V(2) {
glog.Infof("Setting %v cookie with value: %v", cookie.Name, cookie.Value)
}
logs.Infof("Setting %v cookie with value: %v", cookie.Name, cookie.Value)

r.AddCookie(cookie) // so we can find it later if required
http.SetCookie(w, cookie)
Expand Down Expand Up @@ -344,9 +321,7 @@ func clearCookie(w http.ResponseWriter, c *http.Cookie) {

// setSession stores the session id to ticket mapping in the Client.
func (c *Client) setSession(id string, ticket string) {
if glog.V(2) {
glog.Infof("Recording session, %v -> %v", id, ticket)
}
logs.Infof("Recording session, %v -> %v", id, ticket)

c.sessions.Set(id, ticket)
}
Expand All @@ -357,10 +332,7 @@ func (c *Client) clearSession(w http.ResponseWriter, r *http.Request) {

if serviceTicket, ok := c.sessions.Get(cookie.Value); ok {
if err := c.tickets.Delete(serviceTicket); err != nil {
fmt.Printf("Failed to remove %v from %T: %v\n", cookie.Value, c.tickets, err)
if glog.V(2) {
glog.Errorf("Failed to remove %v from %T: %v", cookie.Value, c.tickets, err)
}
logs.Errorf("Failed to remove %v from %T: %v", cookie.Value, c.tickets, err)
}

c.deleteSession(cookie.Value)
Expand Down
8 changes: 4 additions & 4 deletions example_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"net/http"
"net/url"

"github.com/golang/glog"
"gopkg.in/cas.v2/logs"
)

type myHandler struct{}
Expand All @@ -32,7 +32,7 @@ func Example() {
return
}

glog.Info("Starting up")
logs.Info("Starting up")

m := http.NewServeMux()
m.Handle("/", MyHandler)
Expand All @@ -48,10 +48,10 @@ func Example() {
}

if err := server.ListenAndServe(); err != nil {
glog.Infof("Error from HTTP Server: %v", err)
logs.Infof("Error from HTTP Server: %v", err)
}

glog.Info("Shutting down")
logs.Info("Shutting down")
}

type templateBinding struct {
Expand Down
1 change: 0 additions & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ module gopkg.in/cas.v2
go 1.12

require (
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b
github.com/stretchr/testify v1.4.0
gopkg.in/yaml.v2 v2.2.2
)
3 changes: 1 addition & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b h1:VKtxabqXZkF25pY9ekfRL6a582T4P37/31XEstQ5p58=
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
Expand Down
6 changes: 2 additions & 4 deletions handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"fmt"
"net/http"

"github.com/golang/glog"
"gopkg.in/cas.v2/logs"
)

const (
Expand All @@ -20,9 +20,7 @@ type clientHandler struct {
// ServeHTTP handles HTTP requests, processes CAS requests
// and passes requests up to its child http.Handler.
func (ch *clientHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
if glog.V(2) {
glog.Infof("cas: handling %v request for %v", r.Method, r.URL)
}
logs.Infof("cas: handling %v request for %v", r.Method, r.URL)

setClient(r, ch.c)

Expand Down
Loading