Added missing spec annotations for endpoint spec in options.go

Author: sacOO7

ably/options.go

@@ -68,11 +68,11 @@ func getPrimaryNonProdHost(root string) string {
 }
 
 func getEndpointFallbackHosts(endpoint string) []string {
-	if strings.HasPrefix(endpoint, "nonprod:") {
+	if strings.HasPrefix(endpoint, "nonprod:") { // REC2c3
 		root := strings.TrimPrefix(endpoint, "nonprod:")
 		return endpointFallbacks(root, "ably-realtime-nonprod.com")
 	}
-	return endpointFallbacks(endpoint, "ably-realtime.com")
+	return endpointFallbacks(endpoint, "ably-realtime.com") // REC2c4
 }
 
 // endpointFallbacks generates a list of fallback hosts based on the given namespace and root.
@@ -428,6 +428,7 @@ type clientOptions struct {
 }
 
 func (opts *clientOptions) validate() error {
+	// REC1b1
 	if !empty(opts.Endpoint) && (!empty(opts.Environment) || !empty(opts.RealtimeHost) || !empty(opts.RESTHost) || opts.FallbackHostsUseDefault) {
 		err := errors.New("invalid client option: cannot use endpoint with any of deprecated options environment, realtimeHost, restHost or FallbackHostsUseDefault")
 		logger := opts.LogHandler
@@ -507,20 +508,21 @@ func isEndpointFQDN(endpoint string) bool {
 	return strings.Contains(endpoint, ".") || strings.Contains(endpoint, "::") || endpoint == "localhost"
 }
 
-// REC2
+// REC1b
 func (opts *clientOptions) getHostnameFromEndpoint() string {
 	endpoint := opts.Endpoint
 	if empty(endpoint) {
 		return defaultPrimaryHost
 	}
-	if isEndpointFQDN(endpoint) {
+	if isEndpointFQDN(endpoint) { // REC1b2
 		return endpoint
 	}
+	// REC1b3
 	if strings.HasPrefix(endpoint, "nonprod:") {
 		root := strings.TrimPrefix(endpoint, "nonprod:")
 		return getPrimaryNonProdHost(root)
 	}
-	return getPrimaryProdHost(endpoint)
+	return getPrimaryProdHost(endpoint) // REC1b4
 }
 
 func empty(s string) bool {
@@ -556,12 +558,12 @@ func (opts *clientOptions) realtimeURL(realtimeHost string) (realtimeUrl string)
 func (opts *clientOptions) getFallbackHosts() ([]string, error) {
 	if !empty(opts.Endpoint) {
 		if opts.FallbackHosts == nil {
-			if isEndpointFQDN(opts.Endpoint) {
+			if isEndpointFQDN(opts.Endpoint) { // REC2c2
 				return opts.FallbackHosts, nil
 			}
 			return getEndpointFallbackHosts(opts.Endpoint), nil
 		}
-		return opts.FallbackHosts, nil
+		return opts.FallbackHosts, nil //REC2a2
 	}
 
 	logger := opts.LogHandler
@@ -583,7 +585,7 @@ func (opts *clientOptions) getFallbackHosts() ([]string, error) {
 		if opts.isProductionEnvironment() {
 			return defaultOptions.FallbackHosts, nil
 		}
-		return getEndpointFallbackHosts(opts.Environment), nil
+		return getEndpointFallbackHosts(opts.Environment), nil // REC2c5
 	}
 	return opts.FallbackHosts, nil
 }

ably/realtime_conn.go

@@ -388,7 +388,6 @@ func (c *Connection) connectWith(arg connArgs) (result, error) {
 
 	var conn conn
 	primaryHost := c.opts.getRealtimeHost()
-
 	hosts := []string{primaryHost}
 	fallbackHosts, err := c.opts.getFallbackHosts()
 	if err != nil {

ablytest/sandbox.go

@@ -100,12 +100,9 @@ var PresenceFixtures = func() []Presence {
 }
 
 type Sandbox struct {
-	Config *Config
-
-	// Endpoint is the hostname to connect to
+	Config   *Config
 	Endpoint string
-
-	client *http.Client
+	client   *http.Client
 }
 
 func NewRealtime(opts ...ably.ClientOption) (*Sandbox, *ably.Realtime) {