Skip to content
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.

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

Fix crash when handling a dialog result #1417

Merged
merged 2 commits into from
Apr 29, 2024
Merged

Fix crash when handling a dialog result #1417

merged 2 commits into from
Apr 29, 2024

Conversation

emawby
Copy link
Contributor

@emawby emawby commented Apr 24, 2024

Description

One Line Summary

Fix a crash when handling a dialog result (often from requesting location or notification permission when permission has already been denied.)

Details

The stack traces point to crashing when calling [self.queue removeObjectAtIndex:0]; in delayResult. This was never reproducible as the queue should never be empty when calling delayResult, but this PR adds thread safety and a sanity check to protect and this crash.

  • Synchronize queue reads and writes on self.queue

  • Additionally verify that queue.count > 0 prior to removing object at index 0

Motivation

Fix crash

Scope

iOS dialogs

Testing

Unit testing

no infrastructure in place yet for mocking handling prompting actions

Manual testing

Tested by spamming the permission dialog actions

Affected code checklist

  • Notifications
    • Display
    • Open
    • Push Processing
    • Confirm Deliveries
  • Outcomes
  • Sessions
  • In-App Messaging
  • REST API requests
  • Public API changes

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
    • If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
  • Any Public API changes are explained in the PR details and conform to existing APIs

Testing

  • I have included test coverage for these changes, or explained why they are not needed
  • All automated tests pass, or I explained why that is not possible
  • I have personally tested this on my device, or explained why that is not possible

Final pass

  • Code is as readable as possible.
    • Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
  • I have reviewed this PR myself, ensuring it meets each checklist item
    • WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

This change is Reviewable

Additionally verify that queue.count > 0 prior to removing object at index 0
@emawby emawby changed the title WiP Fix crash when handling a dialog result Fix crash when handling a dialog result Apr 24, 2024
@emawby emawby requested a review from nan-li April 24, 2024 21:57
Copy link
Contributor

@nan-li nan-li left a comment

Choose a reason for hiding this comment

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

Do you know if there are consequences to calling displayDialog within the lock?

@emawby
Copy link
Contributor Author

emawby commented Apr 29, 2024

Do you know if there are consequences to calling displayDialog within the lock?

I moved the calls outside of the sync blocks since I don't think they need to be inside. Both had the same results when testing, but this seems better.

@emawby emawby requested a review from nan-li April 29, 2024 16:43
@emawby emawby merged commit 867a449 into main Apr 29, 2024
4 of 5 checks passed
@emawby emawby deleted the fix/delay_result_crash branch April 29, 2024 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants