Add support for changing the gocql connect timeout (#4874)

* Add support for changing the gocql connect timout

* Fix comment typo

Author: johndelcastillo

common/persistence/nosql/nosqlplugin/cassandra/gocql/interface.go

@@ -113,5 +113,6 @@ type (
 		Consistency           Consistency
 		SerialConsistency     SerialConsistency
 		Timeout               time.Duration
+		ConnectTimeout        time.Duration
 	}
 )

common/persistence/nosql/nosqlplugin/cassandra/gocql/session.go

@@ -71,6 +71,8 @@ func initSession(
 	cluster.Consistency = mustConvertConsistency(config.Consistency)
 	cluster.SerialConsistency = mustConvertSerialConsistency(config.SerialConsistency)
 	cluster.Timeout = config.Timeout
+	cluster.ConnectTimeout = config.ConnectTimeout
+
 	return cluster.CreateSession()
 }
 

common/persistence/nosql/nosqlplugin/cassandra/plugin.go

@@ -35,6 +35,7 @@ const (
 	// PluginName is the name of the plugin
 	PluginName            = "cassandra"
 	defaultSessionTimeout = 10 * time.Second
+	defaultConnectTimeout = 2 * time.Second
 )
 
 type plugin struct{}
@@ -97,5 +98,6 @@ func toGoCqlConfig(cfg *config.NoSQL) gocql.ClusterConfig {
 		Consistency:           gocql.LocalQuorum,
 		SerialConsistency:     gocql.LocalSerial,
 		Timeout:               defaultSessionTimeout,
+		ConnectTimeout:        defaultConnectTimeout,
 	}
 }

tools/cassandra/cqlclient.go

@@ -47,6 +47,7 @@ type (
 		AllowedAuthenticators []string
 		Keyspace              string
 		Timeout               int
+		ConnectTimeout        int
 		NumReplicas           int
 		ProtoVersion          int
 		TLS                   *config.TLS
@@ -56,9 +57,10 @@ type (
 var errGetSchemaVersion = errors.New("failed to get current schema version from cassandra")
 
 const (
-	DefaultTimeout       = 30 // Timeout in seconds
-	DefaultCassandraPort = 9042
-	SystemKeyspace       = "system"
+	DefaultTimeout        = 30 // Timeout in seconds
+	DefaultConnectTimeout = 2  // Connect timeout in seconds
+	DefaultCassandraPort  = 9042
+	SystemKeyspace        = "system"
 )
 
 const (
@@ -105,6 +107,7 @@ func NewCQLClient(cfg *CQLClientConfig) (*CqlClient, error) {
 		Keyspace:              cfg.Keyspace,
 		TLS:                   cfg.TLS,
 		Timeout:               time.Duration(cfg.Timeout) * time.Second,
+		ConnectTimeout:        time.Duration(cfg.ConnectTimeout) * time.Second,
 		ProtoVersion:          cfg.ProtoVersion,
 		Consistency:           gocql.All,
 	})

tools/cassandra/handler.go

@@ -95,6 +95,7 @@ func CheckCompatibleVersion(
 		Keyspace:              cfg.Keyspace,
 		AllowedAuthenticators: cfg.AllowedAuthenticators,
 		Timeout:               DefaultTimeout,
+		ConnectTimeout:        DefaultConnectTimeout,
 		TLS:                   cfg.TLS,
 		ProtoVersion:          cfg.ProtoVersion,
 	})
@@ -177,6 +178,7 @@ func newCQLClientConfig(cli *cli.Context) (*CQLClientConfig, error) {
 	cqlConfig.User = cli.GlobalString(schema.CLIOptUser)
 	cqlConfig.Password = cli.GlobalString(schema.CLIOptPassword)
 	cqlConfig.Timeout = cli.GlobalInt(schema.CLIOptTimeout)
+	cqlConfig.ConnectTimeout = cli.GlobalInt(schema.CLIOptConnectTimeout)
 	cqlConfig.Keyspace = cli.GlobalString(schema.CLIOptKeyspace)
 	cqlConfig.NumReplicas = cli.Int(schema.CLIOptReplicationFactor)
 	cqlConfig.ProtoVersion = cli.Int(schema.CLIOptProtoVersion)

tools/cassandra/main.go

@@ -93,6 +93,11 @@ func BuildCLIOptions() *cli.App {
 			Usage:  "request Timeout in seconds used for cql client",
 			EnvVar: "CASSANDRA_TIMEOUT",
 		},
+		cli.IntFlag{
+			Name:  schema.CLIOptConnectTimeout,
+			Value: DefaultConnectTimeout,
+			Usage: "Connection Timeout in seconds used for cql client",
+		},
 		cli.StringFlag{
 			Name:   schema.CLIFlagKeyspace,
 			Value:  "cadence",

tools/common/schema/types.go

@@ -78,6 +78,8 @@ const (
 	CLIOptPassword = "password"
 	// CLIOptTimeout is the cli option for timeout
 	CLIOptTimeout = "timeout"
+	// CLIOptConnectTimeout is the cli option for connection timeout
+	CLIOptConnectTimeout = "connect-timeout"
 	// CLIOptKeyspace is the cli option for keyspace
 	CLIOptKeyspace = "keyspace"
 	// CLIOptDatabase is the cli option for database
@@ -115,6 +117,8 @@ const (
 	CLIFlagUser = CLIOptUser + ", u"
 	// CLIFlagPassword is the cli flag for password
 	CLIFlagPassword = CLIOptPassword + ", pw"
+	// CLIFlagConnectTimeout is the cli flag for connection timeout
+	CLIFlagConnectTimeout = CLIOptConnectTimeout + ", ct"
 	// CLIFlagTimeout is the cli flag for timeout
 	CLIFlagTimeout = CLIOptTimeout + ", t"
 	// CLIFlagKeyspace is the cli flag for keyspace