address comments

uber · Jul 7, 2017 · 71a53ac · 71a53ac
1 parent 177f82d
commit 71a53ac
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 25 deletions.
diff --git a/backend/repository/client_update.go b/backend/repository/client_update.go
@@ -28,6 +28,7 @@ import (
 	"sort"
 
 	"github.com/pkg/errors"
+	"github.com/uber/zanzibar/codegen"
 )
 
 // ClientJSONConfig defines the JSON content of the configuration file.
@@ -44,7 +45,7 @@ type configField struct {
 }
 
 // NewClientConfigJSON converts ClientConfig to ClientJSONConfig.
-func NewClientConfigJSON(cfg ClientConfig) *ClientJSONConfig {
+func NewClientConfigJSON(cfg *ClientConfig) *ClientJSONConfig {
 	cfgJSON := &ClientJSONConfig{
 		Name: cfg.Name,
 		Type: string(cfg.Type),
@@ -61,7 +62,7 @@ func (r *Repository) UpdateClientConfigs(req *ClientConfig, clientCfgDir, thrift
 	if err := validateClientUpdateRequest(req); err != nil {
 		return err
 	}
-	cfgJSON := NewClientConfigJSON(*req)
+	cfgJSON := NewClientConfigJSON(req)
 	cfgJSON.Config.ThriftFileSha = thriftFileSha
 	clientPath := filepath.Join(r.absPath(clientCfgDir), cfgJSON.Name)
 	r.Lock()
@@ -85,7 +86,7 @@ func validateClientUpdateRequest(req *ClientConfig) error {
 	if len(req.ExposedMethods) == 0 {
 		return errors.New("invalid request: no method is exposed for the client")
 	}
-	if req.Type == "tchannel" && req.MuttleyName == "" {
+	if req.Type == "tchannel" && req.ServiceName == "" {
 		return errors.New("invalid request: muttley name is required for tchannel client")
 	}
 	if req.IP == "" || req.Port == 0 {
@@ -100,17 +101,6 @@ func validateClientUpdateRequest(req *ClientConfig) error {
 	return nil
 }
 
-type clientModuleJSONConfig struct {
-	Name         string       `json:"name"`
-	Type         string       `json:"type"`
-	Config       interface{}  `json:"config"`
-	Dependencies dependencies `json:"dependencies"`
-}
-
-type dependencies struct {
-	Client []string `json:"client"`
-}
-
 // WriteClientModuleJSON writes the JSON file for the module to contain all clients.
 func WriteClientModuleJSON(clientCfgDir string) error {
 	files, err := ioutil.ReadDir(clientCfgDir)
@@ -124,11 +114,11 @@ func WriteClientModuleJSON(clientCfgDir string) error {
 		}
 	}
 	sort.Strings(subDirs)
-	content := &clientModuleJSONConfig{
+	content := &codegen.ClientClassConfig{
 		Name:   "clients",
 		Type:   "init",
-		Config: struct{}{},
-		Dependencies: dependencies{
+		Config: map[string]interface{}{},
+		Dependencies: codegen.ClientDependencies{
 			Client: subDirs,
 		},
 	}
@@ -144,7 +134,7 @@ func UpdateProductionConfigJSON(req *ClientConfig, productionCfgJSONPath string)
 	// Update fields related to a client.
 	prefix := "clients." + req.Name + "."
 	if req.Type == "tchannel" {
-		content[prefix+"serviceName"] = req.MuttleyName
+		content[prefix+"serviceName"] = req.ServiceName
 		content[prefix+"timeout"] = req.Timeout
 		content[prefix+"timeoutPerAttempt"] = req.TimeoutPerAttempt
 	}

diff --git a/backend/repository/config.go b/backend/repository/config.go
@@ -81,7 +81,7 @@ type ClientConfig struct {
 	Name              string            `json:"name"`
 	Type              ProtocolType      `json:"type"`
 	ThriftFile        string            `json:"thriftFile,omitempty"`
-	MuttleyName       string            `json:"muttleyName,omitempty"`
+	ServiceName       string            `json:"serviceName,omitempty"`
 	ExposedMethods    map[string]string `json:"exposedMethods,omitempty"`
 	IP                string            `json:"ip,omitempty"`
 	Port              int64             `json:"port,omitempty"`
@@ -286,7 +286,7 @@ func clientConfig(spec *codegen.ClientSpec, productionCfgJSON map[string]interfa
 		return clientConfig, nil
 	}
 	// tchannel related fields.
-	clientConfig.MuttleyName, err = convStrVal(productionCfgJSON, prefix+"serviceName")
+	clientConfig.ServiceName, err = convStrVal(productionCfgJSON, prefix+"serviceName")
 	if err != nil {
 		return nil, err
 	}

diff --git a/backend/repository/data/client/baz_client_update.json b/backend/repository/data/client/baz_client_update.json
@@ -3,7 +3,7 @@
     "name": "baz",
     "type": "tchannel",
     "thriftFile": "clients/baz/baz.thrift",
-    "muttleyName": "Qux",
+    "serviceName": "Qux",
     "exposedMethods": {
         "Call": "SimpleService::call",
         "Compare": "SimpleService::compare",

diff --git a/backend/repository/data/gateway_config_expected.json b/backend/repository/data/gateway_config_expected.json
@@ -289,7 +289,7 @@
 			"name": "baz",
 			"type": "tchannel",
 			"thriftFile": "clients/baz/baz.thrift",
-			"muttleyName": "Qux",
+			"serviceName": "Qux",
 			"exposedMethods": {
 				"Call": "SimpleService::call",
 				"Compare": "SimpleService::compare",

diff --git a/codegen/gateway.go b/codegen/gateway.go
@@ -110,9 +110,15 @@ type ModuleClassConfig struct {
 // ClientClassConfig represents the specific config for
 // a client. This is a downcast of the moduleClassConfig.
 type ClientClassConfig struct {
-	Name   string                 `json:"name"`
-	Type   string                 `json:"type"`
-	Config map[string]interface{} `json:"config"`
+	Name         string                 `json:"name"`
+	Type         string                 `json:"type"`
+	Config       map[string]interface{} `json:"config"`
+	Dependencies ClientDependencies     `json:"dependencies"`
+}
+
+// ClientDependencies lists all depedencies of a client.
+type ClientDependencies struct {
+	Client []string `json:"client"`
 }
 
 // NewClientSpec creates a client spec from a json file.