Merge pull request #2173 from SmartThingsCommunity/fix/sonos-group-control-regressions

Author: dljsjr

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

@@ -340,6 +340,7 @@ function SonosConnection.new(driver, device)
           self.driver.sonos:get_coordinator_for_device(self.device)
         local _, player_id = self.driver.sonos:get_player_for_device(self.device)
         self.driver.sonos:update_household_info(header.householdId, body, self.device)
+        self.driver.sonos:update_device_record_from_state(header.householdId, self.device)
         local _, updated_coordinator = self.driver.sonos:get_coordinator_for_device(self.device)
 
         Router.cleanup_unused_sockets(self.driver)
@@ -567,7 +568,7 @@ function SonosConnection:coordinator_running()
       )
     )
   end
-  return unique_key and Router.is_connected(unique_key) and self._initialized
+  return type(unique_key) == "string" and Router.is_connected(unique_key) and self._initialized
 end
 
 function SonosConnection:refresh_subscriptions(maybe_reply_tx)

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

@@ -201,28 +201,31 @@ function SonosPersistentSsdpTask:get_player_info(reply_tx, ...)
   local household_id_or_mac = select(1, ...)
   local player_id = select(2, ...)
 
-  local lookup_table, lookup_key, bad_key_part
+  local wait_table_key, lookup_table, lookup_key, bad_key_part
 
   if player_id ~= nil and type(player_id) == "string" then
+    wait_table_key = "waiting_for_unique_key"
     lookup_table = self.player_info_by_sonos_ids
     lookup_key, bad_key_part = utils.sonos_unique_key(household_id_or_mac, player_id)
   else
+    wait_table_key = "waiting_for_mac_addr"
     lookup_table = self.player_info_by_mac_addrs
     lookup_key = household_id_or_mac
   end
 
   if not lookup_key and bad_key_part then
     log.error(string.format("Invalid Unique Key Part: %s", bad_key_part))
   end
+
   local maybe_existing = lookup_table[lookup_key]
   if maybe_existing and maybe_existing.ssdp_info.expires_at > os.time() then
     reply_tx:send(maybe_existing)
     return
   end
 
-  local waiting_for_player = self.waiting_for_unique_key[lookup_key] or {}
+  local waiting_for_player = self[wait_table_key][lookup_key] or {}
   table.insert(waiting_for_player, reply_tx)
-  self.waiting_for_unique_key[lookup_key] = waiting_for_player
+  self[wait_table_key][lookup_key] = waiting_for_player
   self:refresh()
 end
 

drivers/SmartThings/sonos/src/lifecycle_handlers.lua

@@ -117,6 +117,7 @@ function SonosDriverLifecycleHandlers.initialize_device(driver, device)
                       -- This is just in case both receivers are ready, so that we can prioritize
                       -- handling the token instead of putting another request in flight.
                       send_request = true
+                      backoff_timer:handled()
                       backoff_timer = nil
                     end
 
@@ -204,12 +205,12 @@ end
 ---@param device SonosDevice
 function SonosDriverLifecycleHandlers.removed(driver, device)
   log.trace(string.format("%s device removed", device.label))
+  driver.sonos:remove_device_record_association(device)
   driver.dni_to_device_id[device.device_network_id] = nil
   local sonos_conn = device:get_field(PlayerFields.CONNECTION)
   if sonos_conn and sonos_conn:is_running() then
     sonos_conn:stop()
   end
-  driver.sonos:remove_device_record_association(device)
 end
 
 SonosDriverLifecycleHandlers.added = SonosDriverLifecycleHandlers.handle_initialize_lifecycle_event

drivers/SmartThings/sonos/src/sonos_driver.lua

@@ -490,7 +490,6 @@ function SonosDriver:handle_player_discovery_info(api_key, info, device)
       )
   end
 
-  ---
   --- @cast response SonosGroupsResponseBody
   self.sonos:update_household_info(info.ssdp_info.household_id, response)