From cc2c98f9615d0745b733e860f9f1517f7edc5f44 Mon Sep 17 00:00:00 2001
From: Mitchell Hashimoto <mitchell.hashimoto@gmail.com>
Date: Tue, 17 Apr 2018 18:42:49 -0500
Subject: [PATCH] agent/cache: lots of comment/doc updates

---
 agent/cache/cache.go   | 27 +++++++++++++++++++++++----
 agent/cache/request.go |  7 +++++--
 2 files changed, 28 insertions(+), 6 deletions(-)

diff --git a/agent/cache/cache.go b/agent/cache/cache.go
index a9727ab8e6..5bf7b787d1 100644
--- a/agent/cache/cache.go
+++ b/agent/cache/cache.go
@@ -7,9 +7,11 @@
 // balance performance and correctness, depending on the type of data being
 // requested.
 //
-// Currently, the cache package supports only continuous, blocking query
-// caching. This means that the cache update is edge-triggered by Consul
-// server blocking queries.
+// The types of data that can be cached is configurable via the Type interface.
+// This allows specialized behavior for certain types of data. Each type of
+// Consul data (CA roots, leaf certs, intentions, KV, catalog, etc.) will
+// have to be manually implemented. This usually is not much work, see
+// the "agent/cache-types" package.
 package cache
 
 import (
@@ -23,7 +25,24 @@ import (
 
 //go:generate mockery -all -inpkg
 
-// Cache is a agent-local cache of Consul data.
+// Cache is a agent-local cache of Consul data. Create a Cache using the
+// New function. A zero-value Cache is not ready for usage and will result
+// in a panic.
+//
+// The types of data to be cached must be registered via RegisterType. Then,
+// calls to Get specify the type and a Request implementation. The
+// implementation of Request is usually done directly on the standard RPC
+// struct in agent/structs.  This API makes cache usage a mostly drop-in
+// replacement for non-cached RPC calls.
+//
+// The cache is partitioned by ACL and datacenter. This allows the cache
+// to be safe for multi-DC queries and for queries where the data is modified
+// due to ACLs all without the cache having to have any clever logic, at
+// the slight expense of a less perfect cache.
+//
+// The Cache exposes various metrics via go-metrics. Please view the source
+// searching for "metrics." to see the various metrics exposed. These can be
+// used to explore the performance of the cache.
 type Cache struct {
 	// Keeps track of the cache hits and misses in total. This is used by
 	// tests currently to verify cache behavior and is not meant for general
diff --git a/agent/cache/request.go b/agent/cache/request.go
index 7beec58e86..7cd53df256 100644
--- a/agent/cache/request.go
+++ b/agent/cache/request.go
@@ -4,7 +4,7 @@ import (
 	"time"
 )
 
-// Request is a cache-able request.
+// Request is a cacheable request.
 //
 // This interface is typically implemented by request structures in
 // the agent/structs package.
@@ -20,6 +20,8 @@ type RequestInfo struct {
 	// Key is a unique cache key for this request. This key should
 	// absolutely uniquely identify this request, since any conflicting
 	// cache keys could result in invalid data being returned from the cache.
+	// The Key does not need to include ACL or DC information, since the
+	// cache already partitions by these values prior to using this key.
 	Key string
 
 	// Token is the ACL token associated with this request.
@@ -43,6 +45,7 @@ type RequestInfo struct {
 
 	// Timeout is the timeout for waiting on a blocking query. When the
 	// timeout is reached, the last known value is returned (or maybe nil
-	// if there was no prior value).
+	// if there was no prior value). This "last known value" behavior matches
+	// normal Consul blocking queries.
 	Timeout time.Duration
 }