refactor: update cdk cache interface based on feedback

cli/cmd/cdk.go

@@ -69,10 +69,11 @@ func (c *cliState) ReadCache(ctx context.Context, in *cdk.ReadCacheRequest) (*cd
 
 	var data []byte
 	if !c.ReadCachedAsset(in.Key, &data) { // not expired
-		return &cdk.ReadCacheResponse{Miss: false, Data: data}, nil
+		return &cdk.ReadCacheResponse{Hit: true, Data: data}, nil
 	}
 	return &cdk.ReadCacheResponse{
-		Miss: true,
+		Hit:  false,
+		Data: nil,
 	}, nil
 }
 
@@ -84,9 +85,9 @@ func (c *cliState) WriteCache(ctx context.Context, in *cdk.WriteCacheRequest) (*
 	err := c.writeAssetToCache(in.Key, in.Expires.AsTime(), in.Data)
 	if err != nil {
 		msg := err.Error()
-		return &cdk.WriteCacheResult{Success: false, Msg: &msg}, nil
+		return &cdk.WriteCacheResult{Error: true, Message: msg}, nil
 	}
-	return &cdk.WriteCacheResult{Success: true}, nil
+	return &cdk.WriteCacheResult{Error: false, Message: ""}, nil
 }
 
 // Ping implements CDK.Ping

integration/test_resources/cdk/go-component/main.go

@@ -115,8 +115,8 @@ func app() error {
 		if err != nil {
 			return err
 		}
-		if !r.Success {
-			return fmt.Errorf("failed to write to cache: %s", *r.Msg)
+		if r.Error {
+			return fmt.Errorf("failed to write to cache: %s", r.Message)
 		}
 		return nil
 

proto/v1/cdk.proto

@@ -60,22 +60,31 @@ message HoneyventRequest {
   int64 duration_ms = 4;
 }
 
+// WriteCacheRequest is used to submit data that should be written to cache, included its expiry
 message WriteCacheRequest {
+  // name of the cache key to write
   string key = 1;
   bytes data = 2;
   google.protobuf.Timestamp expires = 3;
 }
 
+// ReadCacheRequest is used to fetch data from the cache
 message ReadCacheRequest {
+  // name of the cache key to read
   string key = 1;
 }
 
+// ReadCacheResponse is the response type after a ReadCacheRequest is made
 message ReadCacheResponse {
-  bool miss = 1;
-  optional bytes data = 2; // body is empty if cache miss
+  // hit is true when data was found, false otherwise
+  bool hit = 1;
+  // empty if cache miss (hit == false)
+  bytes data = 2; 
 }
 
+// WriteCacheResult is the response type after a WriteCacheRequest is made
 message WriteCacheResult {
-  bool success = 1;
-  optional string msg = 2; // error message is empty if success true
+  bool error = 1;
+  // message stores the error body if error == true, otherwise empty
+  string message = 2;
 }