fix: spurious oauth token requests when we already have a valid token.

Author: dljsjr

drivers/SmartThings/sonos/src/api/sonos_connection.lua

@@ -339,9 +339,11 @@ function SonosConnection.new(driver, device)
             device.log.warn(
               string.format("WebSocket connection no longer authorized, disconnecting")
             )
-            local _, security_err = driver:request_oauth_token()
-            if security_err then
-              log.warn(string.format("Error during request for oauth token: %s", security_err))
+            if not driver:is_waiting_for_oauth_token() then
+              local _, security_err = driver:request_oauth_token()
+              if security_err then
+                log.warn(string.format("Error during request for oauth token: %s", security_err))
+              end
             end
             -- closing the socket directly without calling `:stop()` triggers the reconnect loop,
             -- which is where we wait for the token to come in.

drivers/SmartThings/sonos/src/sonos_driver.lua

@@ -184,11 +184,15 @@ function SonosDriver:notify_augmented_data_changed(update_kind, update_key, upda
     )
   end
 
-  if
-    self.oauth.endpoint_app_info
+  local maybe_token, _ = self:get_oauth_token()
+
+  local should_request_token = self.oauth.endpoint_app_info
     and self.oauth.endpoint_app_info.state == "connected"
     and not already_connected
-  then
+    and type(maybe_token) ~= "table"
+    and not self:is_waiting_for_oauth_token()
+
+  if should_request_token then
     local _, err = self:request_oauth_token()
     if err then
       log.error(string.format("Request OAuth token error: %s", err))
@@ -322,6 +326,17 @@ function SonosDriver:check_auth(info_or_device)
     )
 end
 
+---@return boolean is_connected
+function SonosDriver:is_account_linked()
+  return (
+    self.oauth
+    and self.oauth.endpoint_app_info
+    and self.oauth.endpoint_app_info.state == "connected"
+  )
+      and true
+    or false
+end
+
 ---@return any? ret nil on permissions violation
 ---@return string? error nil on success
 function SonosDriver:request_oauth_token()
@@ -333,13 +348,17 @@ function SonosDriver:request_oauth_token()
     log.warn(string.format("get oauth token error: %s", maybe_err))
   end
   if type(maybe_token) == "table" and type(maybe_token.accessToken) == "string" then
+    self.waiting_for_oauth_token = false
     self.oauth_token_bus:send(maybe_token)
+    return true
   end
   local result, err = security.get_sonos_oauth()
   if not result then
     return nil, string.format("Error requesting OAuth token via Security API: %s", err)
   end
-  self.waiting_for_oauth_token = true
+  -- if the account isn't linked, then we're not actually "waiting" for the token yet,
+  -- because we need to wait for the account link to succeed and the endpoint app upsert
+  self.waiting_for_oauth_token = self:is_account_linked()
   return result, err
 end