Use endpoint as default connection option (ADR-119)

ably/http/http.py

@@ -140,9 +140,9 @@ def dump_body(self, body):
  else:
  return json.dumps(body, separators=(',', ':'))
 
- def get_rest_hosts(self):
- hosts = self.options.get_rest_hosts()
- host = self.__host or self.options.fallback_realtime_host
+ def get_hosts(self):
+ hosts = self.options.get_hosts()
+ host = self.__host or self.options.fallback_host
  if host is None:
  return hosts
 
@@ -186,7 +186,7 @@ async def make_request(self, method, path, version=None, headers=None, body=None
  http_max_retry_duration = self.http_max_retry_duration
  requested_at = time.time()
 
- hosts = self.get_rest_hosts()
+ hosts = self.get_hosts()
  for retry_count, host in enumerate(hosts):
  def should_stop_retrying(retry_count=retry_count):
  time_passed = time.time() - requested_at
@@ -229,7 +229,7 @@ def should_stop_retrying(retry_count=retry_count):
  continue
 
  # Keep fallback host for later (RSC15f)
- if retry_count > 0 and host != self.options.get_rest_host():
+ if retry_count > 0 and host != self.options.get_host():
  self.__host = host
  self.__host_expires = time.time() + (self.options.fallback_retry_timeout / 1000.0)
 
@@ -277,7 +277,7 @@ def options(self):
 
  @property
  def preferred_host(self):
- return self.options.get_rest_host()
+ return self.options.get_host()
 
  @property
  def preferred_port(self):

ably/realtime/connectionmanager.py

@@ -136,7 +136,7 @@ def __init__(self, realtime: AblyRealtime, initial_state):
  self.retry_timer: Timer | None = None
  self.connect_base_task: asyncio.Task | None = None
  self.disconnect_transport_task: asyncio.Task | None = None
- self.__fallback_hosts: list[str] = self.options.get_fallback_realtime_hosts()
+ self.__fallback_hosts: list[str] = self.options.get_fallback_hosts()
  self.queued_messages: deque[PendingMessage] = deque()
  self.__error_reason: AblyException | None = None
  self.msg_serial: int = 0
@@ -551,7 +551,7 @@ async def connect_with_fallback_hosts(self, fallback_hosts: list) -> Exception |
 
  async def connect_base(self) -> None:
  fallback_hosts = self.__fallback_hosts
- primary_host = self.options.get_realtime_host()
+ primary_host = self.options.get_host()
  try:
  await self.try_host(primary_host)
  return

ably/realtime/realtime.py

@@ -48,10 +48,14 @@ def __init__(self, key: Optional[str] = None, loop: Optional[asyncio.AbstractEve
  You can set this to false and explicitly connect to Ably using the
  connect() method. The default is true.
  **kwargs: client options
+ endpoint: str
+ Endpoint specifies either a routing policy name or fully qualified domain name to connect to Ably.
  realtime_host: str
+ Deprecated: this property is deprecated and will be removed in a future version.
  Enables a non-default Ably host to be specified for realtime connections.
  For development environments only. The default value is realtime.ably.io.
  environment: str
+ Deprecated: this property is deprecated and will be removed in a future version.
  Enables a custom environment to be used with the Ably service. Defaults to `production`
  realtime_request_timeout: float
  Timeout (in milliseconds) for the wait of acknowledgement for operations performed via a realtime

ably/rest/rest.py

@@ -32,8 +32,14 @@ def __init__(self, key: Optional[str] = None, token: Optional[str] = None,
 
  **Optional Parameters**
  - `client_id`: Undocumented
- - `rest_host`: The host to connect to. Defaults to rest.ably.io
- - `environment`: The environment to use. Defaults to 'production'
+ - `endpoint`: Endpoint specifies either a routing policy name or
+ fully qualified domain name to connect to Ably.
+ - `rest_host`: Deprecated: this property is deprecated and will
+ be removed in a future version. The host to connect to.
+ Defaults to rest.ably.io
+ - `environment`: Deprecated: this property is deprecated and
+ will be removed in a future version. The environment to use.
+ Defaults to 'production'
  - `port`: The port to connect to. Defaults to 80
  - `tls_port`: The tls_port to connect to. Defaults to 443
  - `tls`: Specifies whether the client should use TLS. Defaults

ably/transport/defaults.py

@@ -1,17 +1,8 @@
 class Defaults:
  protocol_version = "5"
- fallback_hosts = [
- "a.ably-realtime.com",
- "b.ably-realtime.com",
- "c.ably-realtime.com",
- "d.ably-realtime.com",
- "e.ably-realtime.com",
- ]
-
- rest_host = "rest.ably.io"
- realtime_host = "realtime.ably.io" # RTN2
+
  connectivity_check_url = "https://internet-up.ably-realtime.com/is-the-internet-up.txt"
-environment = 'production'
+endpoint = 'main'
 
  port = 80
  tls_port = 443
@@ -53,11 +44,34 @@ def get_scheme(options):
  return "http"
 
  @staticmethod
- def get_environment_fallback_hosts(environment):
+ def get_hostname(endpoint):
+ if "." in endpoint or "::" in endpoint or "localhost" in endpoint:
+ return endpoint
+
+ if endpoint.startswith("nonprod:"):
+ return endpoint[len("nonprod:"):] + ".realtime.ably-nonprod.net"
+
+ return endpoint + ".realtime.ably.net"
+
+ @staticmethod
+ def get_fallback_hosts(endpoint="main"):
+ if "." in endpoint or "::" in endpoint or "localhost" in endpoint:
+ return []
+
+ if endpoint.startswith("nonprod:"):
+ root = endpoint.replace("nonprod:", "")
+ return [
+ root + ".a.fallback.ably-realtime-nonprod.com",
+ root + ".b.fallback.ably-realtime-nonprod.com",
+ root + ".c.fallback.ably-realtime-nonprod.com",
+ root + ".d.fallback.ably-realtime-nonprod.com",
+ root + ".e.fallback.ably-realtime-nonprod.com",
+ ]
+
  return [
-environment + "-a-fallback.ably-realtime.com",
-environment + "-b-fallback.ably-realtime.com",
-environment + "-c-fallback.ably-realtime.com",
-environment + "-d-fallback.ably-realtime.com",
-environment + "-e-fallback.ably-realtime.com",
+endpoint + ".a.fallback.ably-realtime.com",
+endpoint + ".b.fallback.ably-realtime.com",
+endpoint + ".c.fallback.ably-realtime.com",
+endpoint + ".d.fallback.ably-realtime.com",
+endpoint + ".e.fallback.ably-realtime.com",
  ]

ably/transport/websockettransport.py

@@ -143,8 +143,8 @@ async def on_protocol_message(self, msg):
  self.max_idle_interval = max_idle_interval + self.options.realtime_request_timeout
  self.on_activity()
  self.is_connected = True
- if self.host != self.options.get_realtime_host(): # RTN17e
- self.options.fallback_realtime_host = self.host
+ if self.host != self.options.get_host(): # RTN17e
+ self.options.fallback_host = self.host
  self.connection_manager.on_connected(connection_details, connection_id, reason=exception)
  elif action == ProtocolMessageAction.DISCONNECTED:
  error = msg.get('error')