Add reproduction to Issue #2125

[adrianryt]

Description

This PR aims to reproduce and solve #2125. Following the discussion in PR2175 I create a reproduction for the issue.

Changes

• Create Test2125 with reproduction to issue react-navigation: App randomly freezes when react-native Modal is shown while preventing remove screen with usePreventRemove on iOS #2125

Test code and steps to reproduce

Reproduction(Architecture: Paper, System: IOS) :

1. Start the application and click "Go To Second Screen" button
2. Click "Home" button to navigate back - modal should appear.
3. Click "Cancel" button in the modal.
4. Sometimes App is frozen, if not, repeat step 2 and 3 many times.

Video:

Screen.Recording.2024-09-27.at.16.48.13.mov

Checklist

• Included code example that can be used to test this change
• Updated TS types
• Updated documentation:
  • https://github.com/software-mansion/react-native-screens/blob/main/guides/GUIDE_FOR_LIBRARY_AUTHORS.md
  • https://github.com/software-mansion/react-native-screens/blob/main/native-stack/README.md
  • https://github.com/software-mansion/react-native-screens/blob/main/src/types.tsx
  • https://github.com/software-mansion/react-native-screens/blob/main/src/native-stack/types.tsx
• Ensured that CI passes