make cycle tracking optional

Author: hcarter-775

drivers/SmartThings/matter-lock/src/new-matter-lock/init.lua

@@ -239,11 +239,11 @@ local function match_profile_switch(driver, device)
 end
 
 --- Deeply compare two values.
---- Handles cycles, metatables, and optional function ignoring.
+--- Handles metatables. Optionally handles cycles and function ignoring.
 ---
 --- @param a any
 --- @param b any
---- @param opts table|nil { ignore_functions = boolean }
+--- @param opts table|nil { ignore_functions = boolean, track_cycles = boolean }
 --- @param seen table|nil
 --- @return boolean
 local function deep_equals(a, b, opts, seen)
@@ -253,11 +253,13 @@ local function deep_equals(a, b, opts, seen)
   if type(a) ~= "table" then return false end -- same type but not table, thus was already compared
 
   -- check for cycles in table references and preserve reference topology.
-  seen = seen or { a_to_b = {}, b_to_a = {} }
-  if seen.a_to_b[a] ~= nil then return seen.a_to_b[a] == b end
-  if seen.b_to_a[b] ~= nil then return seen.b_to_a[b] == a end
-  seen.a_to_b[a] = b
-  seen.b_to_a[b] = a
+  if opts and opts.track_cycles then
+    seen = seen or { a_to_b = {}, b_to_a = {} }
+    if seen.a_to_b[a] ~= nil then return seen.a_to_b[a] == b end
+    if seen.b_to_a[b] ~= nil then return seen.b_to_a[b] == a end
+    seen.a_to_b[a] = b
+    seen.b_to_a[b] = a
+  end
 
   -- Compare keys/values from a
   for k, v in next, a do

drivers/SmartThings/matter-sensor/src/sub_drivers/air_quality_sensor/air_quality_sensor_utils/utils.lua

@@ -78,11 +78,11 @@ function AirQualitySensorUtils.set_supported_health_concern_values(device)
 end
 
 --- Deeply compare two values.
---- Handles cycles, metatables, and optional function ignoring.
+--- Handles metatables. Optionally handles cycles and function ignoring.
 ---
 --- @param a any
 --- @param b any
---- @param opts table|nil { ignore_functions = boolean }
+--- @param opts table|nil { ignore_functions = boolean, track_cycles = boolean }
 --- @param seen table|nil
 --- @return boolean
 function AirQualitySensorUtils.deep_equals(a, b, opts, seen)
@@ -92,11 +92,13 @@ function AirQualitySensorUtils.deep_equals(a, b, opts, seen)
   if type(a) ~= "table" then return false end -- same type but not table, thus was already compared
 
   -- check for cycles in table references and preserve reference topology.
-  seen = seen or { a_to_b = {}, b_to_a = {} }
-  if seen.a_to_b[a] ~= nil then return seen.a_to_b[a] == b end
-  if seen.b_to_a[b] ~= nil then return seen.b_to_a[b] == a end
-  seen.a_to_b[a] = b
-  seen.b_to_a[b] = a
+  if opts and opts.track_cycles then
+    seen = seen or { a_to_b = {}, b_to_a = {} }
+    if seen.a_to_b[a] ~= nil then return seen.a_to_b[a] == b end
+    if seen.b_to_a[b] ~= nil then return seen.b_to_a[b] == a end
+    seen.a_to_b[a] = b
+    seen.b_to_a[b] = a
+  end
 
   -- Compare keys/values from a
   for k, v in next, a do

drivers/SmartThings/matter-sensor/src/sub_drivers/air_quality_sensor/init.lua

@@ -65,6 +65,7 @@ function AirQualitySensorLifecycleHandlers.device_init(driver, device)
   device:subscribe()
 end
 
+local st_utils = require "st.utils" --- IGNORE ---
 function AirQualitySensorLifecycleHandlers.info_changed(driver, device, event, args)
   if not aqs_utils.deep_equals(device.profile, args.old_st_store.profile, { ignore_functions = true }) then
     if device:get_field(fields.SUPPORTED_COMPONENT_CAPABILITIES) then

drivers/SmartThings/matter-switch/src/switch_utils/utils.lua

@@ -327,11 +327,11 @@ function utils.create_multi_press_values_list(size, supportsHeld)
 end
 
 --- Deeply compare two values.
---- Handles cycles, metatables, and optional function ignoring.
+--- Handles metatables. Optionally handles cycles and function ignoring.
 ---
 --- @param a any
 --- @param b any
---- @param opts table|nil { ignore_functions = boolean }
+--- @param opts table|nil { ignore_functions = boolean, track_cycles = boolean }
 --- @param seen table|nil
 --- @return boolean
 function utils.deep_equals(a, b, opts, seen)
@@ -341,11 +341,13 @@ function utils.deep_equals(a, b, opts, seen)
   if type(a) ~= "table" then return false end -- same type but not table, thus was already compared
 
   -- check for cycles in table references and preserve reference topology.
-  seen = seen or { a_to_b = {}, b_to_a = {} }
-  if seen.a_to_b[a] ~= nil then return seen.a_to_b[a] == b end
-  if seen.b_to_a[b] ~= nil then return seen.b_to_a[b] == a end
-  seen.a_to_b[a] = b
-  seen.b_to_a[b] = a
+  if opts and opts.track_cycles then
+    seen = seen or { a_to_b = {}, b_to_a = {} }
+    if seen.a_to_b[a] ~= nil then return seen.a_to_b[a] == b end
+    if seen.b_to_a[b] ~= nil then return seen.b_to_a[b] == a end
+    seen.a_to_b[a] = b
+    seen.b_to_a[b] = a
+  end
 
   -- Compare keys/values from a
   for k, v in next, a do