From 4d323e14dfac1aa0f69ca660ccea6fc3437e20b4 Mon Sep 17 00:00:00 2001
From: Alex Dadgar <alex.dadgar@gmail.com>
Date: Thu, 10 Aug 2017 13:07:03 -0700
Subject: [PATCH] Address comments

---
 command/agent/consul/client.go | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/command/agent/consul/client.go b/command/agent/consul/client.go
index a7ee09d1d..44f3d3725 100644
--- a/command/agent/consul/client.go
+++ b/command/agent/consul/client.go
@@ -92,13 +92,13 @@ type AllocRegistration struct {
 	Tasks map[string]*TaskRegistration
 }
 
-func (a *AllocRegistration) Copy() *AllocRegistration {
+func (a *AllocRegistration) copy() *AllocRegistration {
 	c := &AllocRegistration{
 		Tasks: make(map[string]*TaskRegistration, len(a.Tasks)),
 	}
 
 	for k, v := range a.Tasks {
-		c.Tasks[k] = v.Copy()
+		c.Tasks[k] = v.copy()
 	}
 
 	return c
@@ -144,13 +144,13 @@ type TaskRegistration struct {
 	Services map[string]*ServiceRegistration
 }
 
-func (t *TaskRegistration) Copy() *TaskRegistration {
+func (t *TaskRegistration) copy() *TaskRegistration {
 	c := &TaskRegistration{
 		Services: make(map[string]*ServiceRegistration, len(t.Services)),
 	}
 
 	for k, v := range t.Services {
-		c.Services[k] = v.Copy()
+		c.Services[k] = v.copy()
 	}
 
 	return c
@@ -172,7 +172,10 @@ type ServiceRegistration struct {
 	Checks []*api.AgentCheck
 }
 
-func (s *ServiceRegistration) Copy() *ServiceRegistration {
+func (s *ServiceRegistration) copy() *ServiceRegistration {
+	// Copy does not copy the external fields but only the internal fields. This
+	// is so that the caller of AllocRegistrations can not access the internal
+	// fields and that method uses these fields to populate the external fields.
 	return &ServiceRegistration{
 		serviceID: s.serviceID,
 		checkIDs:  helper.CopyMapStringStruct(s.checkIDs),
@@ -672,7 +675,6 @@ func (c *ServiceClient) RegisterTask(allocID string, task *structs.Task, exec dr
 		t.Services[sreg.serviceID] = sreg
 	}
 
-	// Add the task to the allocation's registration
 	// Add the task to the allocation's registration
 	c.addTaskRegistration(allocID, task.Name, t)
 
@@ -809,7 +811,7 @@ func (c *ServiceClient) AllocRegistrations(allocID string) (*AllocRegistration,
 	}
 
 	// Copy so we don't expose internal structs
-	reg := regInternal.Copy()
+	reg := regInternal.copy()
 	c.allocRegistrationsLock.RUnlock()
 
 	// Query the services and checks to populate the allocation registrations.