Skip to content

Delete guest user when SetYearDaySchedule is failed #2876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HunsupJung wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Delete guest user when SetYearDaySchedule is failed #2876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions drivers/SmartThings/matter-lock/src/new-matter-lock/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1550,6 +1550,19 @@ local function clear_user_response_handler(driver, device, ib, response)
delete_aliro_from_table_as_user(device, userIdx)
delete_week_schedule_from_table_as_user(device, userIdx)
delete_year_schedule_from_table_as_user(device, userIdx)
if cmdName == "defaultSchedule" then
Copy link
Copy Markdown
Contributor

@ctowns ctowns Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this handling that is specific to the defaultSchedule command could benefit from a short comment that explains why this is needed to improve readability.

-- Update commandResult
local command_result_info = {
commandName = "addCredential",
userIndex = userIdx,
statusCode = "failure"
}
device:emit_event(capabilities.lockCredentials.commandResult(
command_result_info, {state_change = true, visibility = {displayed = false}}
))
device:set_field(lock_utils.BUSY_STATE, false, {persist = true})
return
end
else
device.log.warn(string.format("Failed to clear user: %s", status))
end
Comment on lines 1566 to 1568
Copy link
Copy Markdown
Contributor

@hcarter-775 hcarter-775 Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the case this fails, what is the expected result?

Given the current logic, a failure would mean that

  1. lockCredentials commandResult is never emitted (HIGH importance)
  2. lockUsers commandResult for defaultSchedules will be emitted below, which will fail (MEDIUM importance)

Should we retry the ClearUser command again? If so, how many times?

Also, if it fails after some number of retries, I think we should emit a success result for lockCredentials. What do you think?

Expand Down Expand Up @@ -2418,17 +2431,22 @@ local function set_year_day_schedule_handler(driver, device, ib, response)
local cmdName = "addCredential"
local credIdx = device:get_field(lock_utils.CRED_INDEX)

-- Update commandResult
local command_result_info = {
commandName = cmdName,
userIndex = userIdx,
credentialIndex = credIdx,
statusCode = status
}
device:emit_event(capabilities.lockCredentials.commandResult(
command_result_info, {state_change = true, visibility = {displayed = false}}
))
device:set_field(lock_utils.BUSY_STATE, false, {persist = true})
if status == "success" then
-- Update commandResult
local command_result_info = {
commandName = cmdName,
userIndex = userIdx,
credentialIndex = credIdx,
statusCode = status
}
device:emit_event(capabilities.lockCredentials.commandResult(
command_result_info, {state_change = true, visibility = {displayed = false}}
))
device:set_field(lock_utils.BUSY_STATE, false, {persist = true})
else
local ep = find_default_endpoint(device, clusters.DoorLock.ID)
device:send(DoorLock.server.commands.ClearUser(device, ep, userIdx))
end
return
end

Expand Down
136 changes: 134 additions & 2 deletions drivers/SmartThings/matter-lock/src/test/test_new_matter_lock.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ local mock_device = test.mock_device.build_test_matter_device({
cluster_id = DoorLock.ID,
cluster_type = "SERVER",
cluster_revision = 1,
feature_map = 0x0181, -- PIN & USR & COTA
feature_map = 0x0591, -- PIN & WDSCH & USR & COTA & YDSCH
}
},
device_types = {
Expand Down Expand Up @@ -76,7 +76,7 @@ local function test_init()
test.socket.capability:__expect_send(
mock_device:generate_test_message("main", capabilities.lock.supportedLockCommands({"lock", "unlock"}, {visibility = {displayed = false}}))
)
mock_device:expect_metadata_update({ profile = "lock-user-pin" })
mock_device:expect_metadata_update({ profile = "lock-user-pin-schedule" })
mock_device:expect_metadata_update({ provisioning_state = "PROVISIONED" })
end

Expand Down Expand Up @@ -2100,4 +2100,136 @@ test.register_coroutine_test(
}
)

-- mock_device:set_field(lock_utils.COTA_CRED, "654123", {persist = true}) --overwrite random cred for test expectation
test.register_coroutine_test(
"Add Guest User and failure response ",
function()
test.socket.capability:__queue_receive(
{
mock_device.id,
{
capability = capabilities.lockCredentials.ID,
command = "addCredential",
args = {0, "guest", "pin", "654123"}
},
}
)
test.socket.matter:__expect_send(
{
mock_device.id,
DoorLock.server.commands.SetCredential(
mock_device, 1, -- endpoint
DoorLock.types.DataOperationTypeEnum.ADD, -- operation_type
DoorLock.types.CredentialStruct(
{credential_type = DoorLock.types.CredentialTypeEnum.PIN, credential_index = 1}
), -- credential
"654123", -- credential_data
nil, -- user_index
nil, -- user_status
DoorLock.types.UserTypeEnum.SCHEDULE_RESTRICTED_USER -- user_type
),
}
)
test.wait_for_events()
test.socket.matter:__queue_receive(
{
mock_device.id,
DoorLock.client.commands.SetCredentialResponse:build_test_command_response(
mock_device, 1,
DoorLock.types.DlStatus.SUCCESS, -- status
1, -- user_index
2 -- next_credential_index
),
}
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main",
capabilities.lockUsers.users({{userIndex = 1, userType = "guest"}}, {visibility={displayed=false}})
)
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main",
capabilities.lockCredentials.credentials(
{{credentialIndex=1, credentialType="pin", userIndex=1}}, {visibility={displayed=false}}
)
)
)
test.socket.matter:__expect_send(
{
mock_device.id,
DoorLock.server.commands.SetYearDaySchedule(
mock_device, 1, -- endpoint
1, -- year_day_index
1, -- user_index
0, -- local_start_time
0xffffffff -- local_end_time
),
}
)
test.wait_for_events()
test.socket.matter:__queue_receive(
{
mock_device.id,
DoorLock.server.commands.SetYearDaySchedule:build_test_command_response(
mock_device, 1,
DoorLock.types.DlStatus.FAILURE -- status
),
}
)
test.socket.matter:__expect_send({
mock_device.id,
DoorLock.server.commands.ClearUser(
mock_device, 1,
1
)
})
test.wait_for_events()
test.socket.matter:__queue_receive(
{
mock_device.id,
DoorLock.server.commands.ClearUser:build_test_command_response(
mock_device, 1
),
}
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main",
capabilities.lockUsers.users({}, {visibility={displayed=false}})
)
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main",
capabilities.lockCredentials.credentials({}, {visibility={displayed=false}})
)
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main",
capabilities.lockSchedules.weekDaySchedules({}, {visibility={displayed=false}})
)
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main",
capabilities.lockSchedules.yearDaySchedules({}, {visibility={displayed=false}})
)
)
test.socket.capability:__expect_send(
mock_device:generate_test_message(
"main",
capabilities.lockCredentials.commandResult(
{commandName="addCredential", statusCode="failure", userIndex=1}, {state_change=true, visibility={displayed=false}}
)
)
)
end,
{
min_api_version = 17
}
)

test.run_registered_tests()
Loading