From af870b87727d00685daabccca0d9830b1ad09530 Mon Sep 17 00:00:00 2001
From: Daniel Smith <dbsmith@google.com>
Date: Thu, 26 Mar 2015 13:28:05 -0700
Subject: [PATCH] Add proper key error type

---
 pkg/client/cache/fifo.go  | 11 +++++------
 pkg/client/cache/store.go | 22 +++++++++++++++++-----
 2 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/pkg/client/cache/fifo.go b/pkg/client/cache/fifo.go
index 685c98fade..eccafd8e06 100644
--- a/pkg/client/cache/fifo.go
+++ b/pkg/client/cache/fifo.go
@@ -17,7 +17,6 @@ limitations under the License.
 package cache
 
 import (
-	"fmt"
 	"sync"
 )
 
@@ -67,7 +66,7 @@ var (
 func (f *FIFO) Add(obj interface{}) error {
 	id, err := f.keyFunc(obj)
 	if err != nil {
-		return fmt.Errorf("couldn't create key for object: %v", err)
+		return KeyError{obj, err}
 	}
 	f.lock.Lock()
 	defer f.lock.Unlock()
@@ -88,7 +87,7 @@ func (f *FIFO) Add(obj interface{}) error {
 func (f *FIFO) AddIfNotPresent(obj interface{}) error {
 	id, err := f.keyFunc(obj)
 	if err != nil {
-		return fmt.Errorf("couldn't create key for object: %v", err)
+		return KeyError{obj, err}
 	}
 	f.lock.Lock()
 	defer f.lock.Unlock()
@@ -113,7 +112,7 @@ func (f *FIFO) Update(obj interface{}) error {
 func (f *FIFO) Delete(obj interface{}) error {
 	id, err := f.keyFunc(obj)
 	if err != nil {
-		return fmt.Errorf("couldn't create key for object: %v", err)
+		return KeyError{obj, err}
 	}
 	f.lock.Lock()
 	defer f.lock.Unlock()
@@ -148,7 +147,7 @@ func (f *FIFO) ListKeys() []string {
 func (f *FIFO) Get(obj interface{}) (item interface{}, exists bool, err error) {
 	key, err := f.keyFunc(obj)
 	if err != nil {
-		return nil, false, fmt.Errorf("couldn't create key for object: %v", err)
+		return nil, false, KeyError{obj, err}
 	}
 	return f.GetByKey(key)
 }
@@ -194,7 +193,7 @@ func (f *FIFO) Replace(list []interface{}) error {
 	for _, item := range list {
 		key, err := f.keyFunc(item)
 		if err != nil {
-			return fmt.Errorf("couldn't create key for object: %v", err)
+			return KeyError{item, err}
 		}
 		items[key] = item
 	}
diff --git a/pkg/client/cache/store.go b/pkg/client/cache/store.go
index 828a1224ba..47d70971c0 100644
--- a/pkg/client/cache/store.go
+++ b/pkg/client/cache/store.go
@@ -49,6 +49,18 @@ type Store interface {
 // KeyFunc knows how to make a key from an object. Implementations should be deterministic.
 type KeyFunc func(obj interface{}) (string, error)
 
+// KeyError will be returned any time a KeyFunc gives an error; it includes the object
+// at fault.
+type KeyError struct {
+	Obj interface{}
+	Err error
+}
+
+// Error gives a human-readable description of the error.
+func (k KeyError) Error() string {
+	return fmt.Sprintf("couldn't create key for object %+v: %v", k.Obj, k.Err)
+}
+
 // MetaNamespaceKeyFunc is a convenient default KeyFunc which knows how to make
 // keys for API objects which implement meta.Interface.
 // The key uses the format: <namespace>/<name>
@@ -79,7 +91,7 @@ type cache struct {
 func (c *cache) Add(obj interface{}) error {
 	key, err := c.keyFunc(obj)
 	if err != nil {
-		return fmt.Errorf("couldn't create key for object: %v", err)
+		return KeyError{obj, err}
 	}
 	// keep a pointer to whatever could have been there previously
 	c.lock.Lock()
@@ -148,7 +160,7 @@ func (c *cache) deleteFromIndices(obj interface{}) error {
 func (c *cache) Update(obj interface{}) error {
 	key, err := c.keyFunc(obj)
 	if err != nil {
-		return fmt.Errorf("couldn't create key for object: %v", err)
+		return KeyError{obj, err}
 	}
 	c.lock.Lock()
 	defer c.lock.Unlock()
@@ -162,7 +174,7 @@ func (c *cache) Update(obj interface{}) error {
 func (c *cache) Delete(obj interface{}) error {
 	key, err := c.keyFunc(obj)
 	if err != nil {
-		return fmt.Errorf("couldn't create key for object: %v", err)
+		return KeyError{obj, err}
 	}
 	c.lock.Lock()
 	defer c.lock.Unlock()
@@ -212,7 +224,7 @@ func (c *cache) Index(indexName string, obj interface{}) ([]interface{}, error)
 func (c *cache) Get(obj interface{}) (item interface{}, exists bool, err error) {
 	key, _ := c.keyFunc(obj)
 	if err != nil {
-		return nil, false, fmt.Errorf("couldn't create key for object: %v", err)
+		return nil, false, KeyError{obj, err}
 	}
 	return c.GetByKey(key)
 }
@@ -234,7 +246,7 @@ func (c *cache) Replace(list []interface{}) error {
 	for _, item := range list {
 		key, err := c.keyFunc(item)
 		if err != nil {
-			return fmt.Errorf("couldn't create key for object: %v", err)
+			return KeyError{item, err}
 		}
 		items[key] = item
 	}