Xcode 14.0 beta 4 reports "Hang Risk" in RCTWebSocket #34400

lucasjohnston · 2022-08-12T16:44:32Z

Description

Error reported: Thread running at QOS_CLASS_USER_INTERACTIVE waiting on a lower QoS thread running at QOS_CLASS_DEFAULT. Investigate ways to avoid priority inversions.
Using Xcode Version 14.0 beta 4 (14A5284g).

Seemingly originates from RCTSRWebSocket.m

Version

0.66.3

Output of `npx react-native info`

info Fetching system and libraries information...
System:
OS: macOS 12.5
CPU: (16) x64 Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
Memory: 186.13 MB / 16.00 GB
Shell: 5.8 - /usr/local/bin/zsh
Binaries:
Node: 14.17.1 - ~/.nvm/versions/node/v14.17.1/bin/node
Yarn: 1.22.10 - ~/src/github.com/umbermoney/daisy/node_modules/.bin/yarn
npm: 6.14.13 - ~/.nvm/versions/node/v14.17.1/bin/npm
Watchman: 4.9.0 - /usr/local/bin/watchman
Managers:
CocoaPods: 1.10.1 - /Users/lucas/.rbenv/shims/pod
SDKs:
iOS SDK:
Platforms: DriverKit 21.4, iOS 15.4, macOS 12.3, tvOS 15.4, watchOS 8.5
Android SDK:
API Levels: 21, 28, 29, 30
Build Tools: 28.0.3, 29.0.2, 29.0.3, 30.0.2
System Images: android-29 | Google APIs Intel x86 Atom, android-31 | Google APIs Intel x86 Atom_64
Android NDK: Not Found
IDEs:
Android Studio: 2021.2 AI-212.5712.43.2112.8609683
Xcode: 13.3/13E113 - /usr/bin/xcodebuild
Languages:
Java: 1.8.0_251 - /Users/lucas/.jenv/shims/javac
npmPackages:
@react-native-community/cli: Not Found
react: 17.0.2 => 17.0.2
react-native: 0.66.3 => 0.66.3
react-native-macos: Not Found
npmGlobalPackages:
react-native: Not Found

Steps to reproduce

Create react-native project on Xcode Version 14.0 beta 4 (14A5284g)
Run application

Snack, code example, screenshot, or link to a repository

react-native/Libraries/WebSocket/RCTSRWebSocket.m

Line 1636 in 6fcfe2e

dispatch_group_wait(_waitGroup, DISPATCH_TIME_FOREVER);

The text was updated successfully, but these errors were encountered:

titanium-cranium · 2022-09-29T06:01:16Z

Any movement on this? Our app is similarly hamstrung after upgrade to iOS16

Quadrified · 2022-09-29T11:05:37Z

Facing the same issue on iOS 15.x and iOS 16 on Xcode 14.0.1
Any alternate fix to at least patch this issue until we wait for a permanent fix?

xuannam12 · 2022-09-30T07:57:00Z

Try clone the new repo for your project!

muhabutt · 2022-09-30T20:35:14Z

Facing the same issue on iOS 15.x and iOS 16 on Xcode 14.0.1. I think there is something wrong with the generated FBReactNativeSpec code.

hamzasohail · 2022-09-30T22:36:13Z

This falls under the same category as discussed here: realm/realm-core#5697

The difference is that this inversion is triggered by a dispatch group but it's the same problem -- the threads in the dispatch group are not running at a QoS higher than "Default". For folks who work on Websocket, there are resolution strategies mentioned in realm/realm-core#5697.

costea93 · 2022-10-05T17:58:49Z

any updates on this?

muhabutt · 2022-10-10T05:58:04Z

Any updates on this issue, I can reproduce this bug on Fresh react native 0.70.2.

bodrius · 2022-10-19T17:41:44Z

the same error

xiongxiongjiang · 2022-10-25T06:45:46Z

same error

xiongxiongjiang · 2022-10-25T06:46:38Z

node_modules/react-native/Libraries/WebSocket/RCTSRWebSocket.m:1632: warning run: Thread running at QOS_CLASS_USER_INTERACTIVE waiting on a lower QoS thread running at QOS_CLASS_DEFAULT. Investigate ways to avoid priority inversions
at:

- (NSRunLoop *)runLoop
{
  dispatch_group_wait(_waitGroup, DISPATCH_TIME_FOREVER);
  return _runLoop;
}

alessioemireni · 2022-10-25T08:01:19Z

+1

george-bafaloukas-forgerock · 2022-10-31T11:04:23Z

+1 This seems present on a Fresh RN upgrade

mmelk · 2022-10-31T16:09:27Z

+1 I cannot connect to the Web Socket in the useEffect() triggered by App State after returning from background state
Need to move to the other view and back to refresh my app

Xcode 14.0.1

SmileYang966 · 2022-11-01T08:30:23Z

+1 who can help to fix this issue?

xclidongbo · 2022-11-02T09:36:38Z

same error

c-shimmer · 2022-11-04T01:50:40Z

+1

xueqiulou · 2022-11-07T08:18:34Z

is there any solution？

JeffGuKang · 2022-11-08T06:56:30Z

Hey guys. Please upvote to the original post instead of adding a +1 comment if you have the same problem or interest this post.

clemente-xyz · 2022-11-09T10:13:07Z

having exactly the same issue. Any updates?

rmoura-92 · 2022-11-09T15:16:26Z

this just popped to me today after running a pod install

rmoura-92 · 2022-11-09T15:36:32Z

this worked for me as temp measure

described here https://developer.apple.com/documentation/xcode/diagnosing-performance-issues-early

voloshink · 2022-11-12T20:31:30Z

this worked for me

described here https://developer.apple.com/documentation/xcode/diagnosing-performance-issues-early

You just turned off the checker, that doesn't mean the underlying issue is solved.

bjornmosten · 2022-11-15T15:49:15Z

I got this too. XCode 14.1. RN 0.69.5
Is anyone actually experiencing any problems from this? Could it be a pre-existing non-issue that XCode just started complaining about?

hamzasohail · 2022-11-15T17:16:36Z

I don't work on React but as I mentioned in my comment above, this issue is pointing to a priority inversion. Priority inversions won't crash your program but can cause performance issues especially when system is under heavy resource contention. This inversion is coming from the React framework itself. Folks who maintain the React framework should audit their usage of dispatch_group_wait -- it's a primitive that doesn't provide priority inversion avoidance.The link (https://developer.apple.com/documentation/xcode/diagnosing-performance-issues-early) explains how these inversions should be addressed.

As for app developers who are seeing this (because they are using React), they should keep an eye on whether this inversion is causing hangs in their app for their app users. If it is, you probably want to deep dive more in the architecture of your app to avoid this inversion.

matthewmturner · 2022-12-02T15:03:51Z

I started having this issue out of the blue. Originally I think it came up when adding a new dependency (react-native-mixpanel) but now im having the issue on all my branches, even without that dep.

Crare · 2022-12-12T10:28:56Z

I get this same error only when running to device. Not happening when building to an iPhone simulator.

System:
OS: macOS 12.5.1
CPU: (10) arm64 Apple M1 Max
Memory: 3.67 GB / 32.00 GB
Shell: 5.8.1 - /bin/zsh
Binaries:
Node: 19.2.0 - /opt/homebrew/bin/node
Yarn: 1.22.19 - /opt/homebrew/bin/yarn
npm: 9.2.0 - /opt/homebrew/bin/npm
Watchman: 2022.12.05.00 - /opt/homebrew/bin/watchman
Managers:
CocoaPods: Not Found
SDKs:
iOS SDK:
Platforms: DriverKit 22.1, iOS 16.1, macOS 13.0, tvOS 16.1, watchOS 9.1
Android SDK: Not Found
IDEs:
Android Studio: 2021.3 AI-213.7172.25.2113.9123335
Xcode: 14.1/14B47b - /usr/bin/xcodebuild
Languages:
Java: Not Found
npmPackages:
@react-native-community/cli: Not Found
react: 18.1.0 => 18.1.0
react-native: 0.70.6 => 0.70.6
react-native-macos: Not Found
npmGlobalPackages:
react-native: Not Found

jbb-dev · 2022-12-19T13:53:34Z

I had the same problem ( and I finally fixed it without really knowing why..., probably an indexing issue from XCODE 14).

If may be it can help you, these are the steps I follow :
1) I cleaned the build folder from XCODE (Product > Clean Build Folder)
2) I removed the DerivedData folder in ~/Library/Developer/Xcode/DerivedData
3) I restarted my computer

After that, I opened my app workspace from XCODE, a file indexing process started and took a very long time (something like 15 or 20 minutes).

Once indexing process finished, I tried to build again and VOILA, this time it worked !

I really hope it will help you.

Regards,

Jean-Baptiste

My system:
OS: macOS 12.6 Monterey
CPU: 1.8 GHz Intel Core i5
Memory: 8 GB 1600 Mhz DDR3
Node : v16.17.1
Xcode: 14.0.1
React: 18.1.0
React-native: 0.70.6

rezkiy37 · 2022-12-28T13:45:37Z

I had the same problem ( and I finally fixed it without really knowing why..., probably an indexing issue from XCODE 14).

If may be it can help you, these are the steps I follow : 1) I cleaned the build folder from XCODE (Product > Clean Build Folder) 2) I removed the DerivedData folder in ~/Library/Developer/Xcode/DerivedData 3) I restarted my computer

After that, I opened my app workspace from XCODE, a file indexing process started and took a very long time (something like 15 or 20 minutes).

Once indexing process finished, I tried to build again and VOILA, this time it worked !

I really hope it will help you.

Regards,

Jean-Baptiste

My system: OS: macOS 12.6 Monterey CPU: 1.8 GHz Intel Core i5 Memory: 8 GB 1600 Mhz DDR3 Node : v16.17.1 Xcode: 14.0.1 React: 18.1.0 React-native: 0.70.6

Thank you!
It works for me!

RubenPM-dev · 2023-01-20T10:57:33Z

I had the same problem ( and I finally fixed it without really knowing why..., probably an indexing issue from XCODE 14).

If may be it can help you, these are the steps I follow : 1) I cleaned the build folder from XCODE (Product > Clean Build Folder) 2) I removed the DerivedData folder in ~/Library/Developer/Xcode/DerivedData 3) I restarted my computer

After that, I opened my app workspace from XCODE, a file indexing process started and took a very long time (something like 15 or 20 minutes).

Once indexing process finished, I tried to build again and VOILA, this time it worked !

I really hope it will help you.

Regards,

Jean-Baptiste

My system: OS: macOS 12.6 Monterey CPU: 1.8 GHz Intel Core i5 Memory: 8 GB 1600 Mhz DDR3 Node : v16.17.1 Xcode: 14.0.1 React: 18.1.0 React-native: 0.70.6

Thanks @jbb-dev

For those looking for the derivedData folder, from Xcode 6 you can find the path under ~/Users/YOUR_USERNAME/Library/Developer/Xcode/DerivedData

Also you can go to Xcode's settings and on the locations tab you can see your derived data path.

The folder is hidden, make sure to press Shift + Cmd + . to show the hidden folders.

xueqiulou · 2023-01-20T10:57:56Z

这是来自QQ邮箱的假期自动回复邮件。您好，我最近正在休假中，无法亲自回复您的邮件。我将在假期结束后，尽快给您回复。

Sharf8351 · 2023-02-19T18:37:22Z

I had the same problem ( and I finally fixed it without really knowing why..., probably an indexing issue from XCODE 14).

If may be it can help you, these are the steps I follow : 1) I cleaned the build folder from XCODE (Product > Clean Build Folder) 2) I removed the DerivedData folder in ~/Library/Developer/Xcode/DerivedData 3) I restarted my computer

After that, I opened my app workspace from XCODE, a file indexing process started and took a very long time (something like 15 or 20 minutes).

Once indexing process finished, I tried to build again and VOILA, this time it worked !

I really hope it will help you.

Regards,

Jean-Baptiste

My system: OS: macOS 12.6 Monterey CPU: 1.8 GHz Intel Core i5 Memory: 8 GB 1600 Mhz DDR3 Node : v16.17.1 Xcode: 14.0.1 React: 18.1.0 React-native: 0.70.6

I tried this but it didn't work for me.

xueqiulou · 2023-02-19T18:37:44Z

这是来自QQ邮箱的假期自动回复邮件。您好，我最近正在休假中，无法亲自回复您的邮件。我将在假期结束后，尽快给您回复。

Arnoldnuo · 2023-03-08T12:45:48Z

Any progress or solution? My app with vlc player hangs constantly, but I cannot find why.

limeup-team · 2023-03-15T10:28:14Z

same issue even on a fresh rn project without any code changes xcode 14.0.1

tido64 · 2023-03-17T13:29:07Z

FWIW, elevating the thread priority suppresses the priority inversion warning:

diff --git a/Libraries/WebSocket/RCTSRWebSocket.m b/Libraries/WebSocket/RCTSRWebSocket.m
index 925596f8677..a6244fb677e 100644
--- a/Libraries/WebSocket/RCTSRWebSocket.m
+++ b/Libraries/WebSocket/RCTSRWebSocket.m
@@ -1688,6 +1688,7 @@ static NSRunLoop *networkRunLoop = nil;
   dispatch_once(&onceToken, ^{
     networkThread = [_RCTSRRunLoopThread new];
     networkThread.name = @"com.squareup.SocketRocket.NetworkThread";
+    networkThread.qualityOfService = NSQualityOfServiceUserInteractive;
     [networkThread start];
     networkRunLoop = networkThread.runLoop;
   });

I have no idea whether this doesn't negatively affects anything else as I have no clue what it is used for.

That said, it looks like this module has recently been replaced: #36471

amgleitman · 2023-03-20T21:47:19Z

That said, it looks like this module has recently been replaced: #36471

Yep. If we wanted to apply this fix right now, the proper place would be in SocketRocket's SRRunLoopThread.m.

Wxm510846302 · 2023-04-07T03:04:24Z

//
// Copyright 2012 Square Inc.
// Portions Copyright (c) 2016-present, Facebook, Inc.
//
// All rights reserved.
//
// This source code is licensed under the BSD-style license found in the
// LICENSE file in the root directory of this source tree. An additional grant
// of patent rights can be found in the PATENTS file in the same directory.
//

#import "SRRunLoopThread.h"
#import <pthread.h>
@interface SRRunLoopThread ()
{
dispatch_group_t _waitGroup;
}

@Property (nonatomic, strong, readwrite) NSRunLoop *runLoop;
@Property (strong, nonatomic) NSLock *lock1;
@Property (assign, nonatomic) pthread_mutex_t lock;
@Property (assign, nonatomic) pthread_cond_t cond;
@EnD

@implementation SRRunLoopThread

(void)dealloc {
// 不用需要销毁
pthread_mutex_destroy(&_lock);
pthread_cond_destroy(&_cond);
}
(void)__initMutex:(pthread_mutex_t *)mutex {
// #define PTHREAD_MUTEX_INITIALIZER {_PTHREAD_MUTEX_SIG_init, {0}}
// self.mutex = PTHREAD_MUTEX_INITIALIZER;

// 静态初始化方法，所以这里不能用这种方式初始化，用下面👇🏻方法初始化
// 1.初始化属性
pthread_mutexattr_t attr;
pthread_mutexattr_init(&attr);
/*
- Mutex type attributes
  */
  // #define PTHREAD_MUTEX_NORMAL 0
  // #define PTHREAD_MUTEX_ERRORCHECK 1
  // #define PTHREAD_MUTEX_RECURSIVE 2
  // #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL
// pthread_mutexattr_settype(&attr, NULL); 传空，默认 PTHREAD_MUTEX_DEFAULT
pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);

// 2.初始化锁
pthread_mutex_init(mutex, &attr);

// 3.销毁属性
pthread_mutexattr_destroy(&attr);

// 初始化条件
pthread_cond_init(&_cond, NULL);

pthread_mutex_lock(mutex);
}

(instancetype)sharedThread
{
static SRRunLoopThread *thread;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
thread = [[SRRunLoopThread alloc] init];
thread.name = @"com.facebook.SocketRocket.NetworkThread";
[thread start];
});
return thread;
}

(instancetype)init
{
self = [super init];
if (self) {
// _waitGroup = dispatch_group_create();
// dispatch_group_enter(_waitGroup);
[self __initMutex:&_lock];
}
return self;
}
(void)main
{

@autoreleasepool {
_runLoop = [NSRunLoop currentRunLoop];
// dispatch_group_leave(_waitGroup);
// 激活一个等待该条件的线程
pthread_cond_signal(&_cond);
NSLog(@"2222");
// Add an empty run loop source to prevent runloop from spinning.
CFRunLoopSourceContext sourceCtx = {
.version = 0,
.info = NULL,
.retain = NULL,
.release = NULL,
.copyDescription = NULL,
.equal = NULL,
.hash = NULL,
.schedule = NULL,
.cancel = NULL,
.perform = NULL
};
CFRunLoopSourceRef source = CFRunLoopSourceCreate(NULL, 0, &sourceCtx);
CFRunLoopAddSource(CFRunLoopGetCurrent(), source, kCFRunLoopDefaultMode);
CFRelease(source);
```
  while ([_runLoop runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]]) {
      
  }
  assert(NO);
```
}
}
(NSRunLoop *)runLoop;
{
// 等待条件（进入休眠，放开mutex锁；被唤醒后，会再次对mutex加锁）
pthread_cond_wait(&_cond, &_lock);
NSLog(@"1111");
return _runLoop;
}

@EnD

这个是我修改的关于SRRunLoopThread.m 的修复。
通过测试socket 可以正常使用。

AsteriskZuo · 2023-07-13T09:05:27Z

FWIW, elevating the thread priority suppresses the priority inversion warning:

diff --git a/Libraries/WebSocket/RCTSRWebSocket.m b/Libraries/WebSocket/RCTSRWebSocket.m
index 925596f8677..a6244fb677e 100644
--- a/Libraries/WebSocket/RCTSRWebSocket.m
+++ b/Libraries/WebSocket/RCTSRWebSocket.m
@@ -1688,6 +1688,7 @@ static NSRunLoop *networkRunLoop = nil;
   dispatch_once(&onceToken, ^{
     networkThread = [_RCTSRRunLoopThread new];
     networkThread.name = @"com.squareup.SocketRocket.NetworkThread";
+    networkThread.qualityOfService = NSQualityOfServiceUserInteractive;
     [networkThread start];
     networkRunLoop = networkThread.runLoop;
   });

I have no idea whether this doesn't negatively affects anything else as I have no clue what it is used for.

That said, it looks like this module has recently been replaced: #36471

Although there are no warnings, as a rule of thumb, it is not appropriate to use the highest priority for both the network thread and the UI thread.

amgleitman · 2023-08-08T20:28:39Z

SocketRocket 0.7.0 fixes this here.

liamjones · 2023-08-31T13:50:11Z

Note that there is a difference between the fix in this thread vs what SocketRocket 0.7.0 does; SocketRocket is using NSQualityOfServiceUserInitiated, the fix in this thread is using NSQualityOfServiceUserInteractive.

jacquesdev · 2023-09-09T22:10:48Z

I've seen this alternative PR to fix the issue, facebookincubator/SocketRocket#659, but not sure which is the best solution. I guess that whichever it is, we'd only be able to get it in a future version of react-native? Just for interest's sake, if this projected updated it's dependency from 0.61 (current) to 0.70 or 0.71, would this still be in a react-native patch release, or would we have to wait for 0.73?

hwangJi-dev · 2023-11-03T02:21:31Z

@cipolleschi
I'm using the latest version 0.72.6 of React-native and SocketRocket 0.6.1

The SocketRocket version dependency specified in React-Core Modules, React-Core is (=0.6.1).

However, when I run the iOS app on Xcode, I get a memory warning message saying 'Hang Risk, Thread running at QOS_CLASS_USER_INTERACTIVE waiting on a lower QoS thread running at QOS_CLASS_DEFAULT. You will encounter a warning that says 'Investigate ways to avoid priority inversions'.
This issue appears to be resolved in SocketRocket version 0.7.0 cc. link
So could you consider updating the dependency version of SocketRocket?

cipolleschi · 2023-11-03T13:47:37Z

yes, we are considering it. We couldn't do it before due to transitive dependencies that would have make other libraries incompatible.

vikrambatra08 · 2024-01-05T09:07:03Z

Any plans for fixing this issue with upcoming releases?

liamjones · 2024-01-05T09:24:37Z

The commit to move SocketRocket to 0.7.0 (which resolves the issue) is already on main: bab9c83 but it doesn't look like it made it into 0.73.0 or 0.73.1 from what I can see in the release tags.

You could request it to be picked to 0.73.2 here: reactwg/react-native-releases#95

lucasjohnston added the Needs: Triage 🔍 label Aug 12, 2022

This was referenced Aug 12, 2022

[IOS] Random app crash on production build software-mansion/react-native-reanimated#2327

Closed

Inconsistent freezing on iOS software-mansion/react-native-reanimated#2244

Closed

D4ryl00 mentioned this issue Sep 20, 2023

[ios] Runtime thread warning gnolang/gnonative#16

Closed

cipolleschi closed this as completed Nov 3, 2023

Xcode 14.0 beta 4 reports "Hang Risk" in RCTWebSocket #34400

Xcode 14.0 beta 4 reports "Hang Risk" in RCTWebSocket #34400

Comments

lucasjohnston commented Aug 12, 2022

Description

Version

Output of npx react-native info

Steps to reproduce

Snack, code example, screenshot, or link to a repository

titanium-cranium commented Sep 29, 2022

Quadrified commented Sep 29, 2022 • edited Loading

xuannam12 commented Sep 30, 2022 • edited Loading

muhabutt commented Sep 30, 2022

hamzasohail commented Sep 30, 2022

costea93 commented Oct 5, 2022

muhabutt commented Oct 10, 2022

bodrius commented Oct 19, 2022

xiongxiongjiang commented Oct 25, 2022

xiongxiongjiang commented Oct 25, 2022

alessioemireni commented Oct 25, 2022

george-bafaloukas-forgerock commented Oct 31, 2022

mmelk commented Oct 31, 2022 • edited Loading

SmileYang966 commented Nov 1, 2022

xclidongbo commented Nov 2, 2022

c-shimmer commented Nov 4, 2022

xueqiulou commented Nov 7, 2022

JeffGuKang commented Nov 8, 2022

clemente-xyz commented Nov 9, 2022

rmoura-92 commented Nov 9, 2022

rmoura-92 commented Nov 9, 2022 • edited Loading

voloshink commented Nov 12, 2022

bjornmosten commented Nov 15, 2022

hamzasohail commented Nov 15, 2022 • edited Loading

matthewmturner commented Dec 2, 2022

Crare commented Dec 12, 2022

jbb-dev commented Dec 19, 2022 • edited Loading

rezkiy37 commented Dec 28, 2022

RubenPM-dev commented Jan 20, 2023 • edited Loading

xueqiulou commented Jan 20, 2023 via email

Sharf8351 commented Feb 19, 2023

xueqiulou commented Feb 19, 2023 via email

Arnoldnuo commented Mar 8, 2023

limeup-team commented Mar 15, 2023

tido64 commented Mar 17, 2023 • edited Loading

amgleitman commented Mar 20, 2023

Wxm510846302 commented Apr 7, 2023

@EnD

AsteriskZuo commented Jul 13, 2023

amgleitman commented Aug 8, 2023

liamjones commented Aug 31, 2023

jacquesdev commented Sep 9, 2023

hwangJi-dev commented Nov 3, 2023 • edited Loading

cipolleschi commented Nov 3, 2023

vikrambatra08 commented Jan 5, 2024

liamjones commented Jan 5, 2024

Output of `npx react-native info`

Quadrified commented Sep 29, 2022 •

edited

Loading

xuannam12 commented Sep 30, 2022 •

edited

Loading

mmelk commented Oct 31, 2022 •

edited

Loading

rmoura-92 commented Nov 9, 2022 •

edited

Loading

hamzasohail commented Nov 15, 2022 •

edited

Loading

jbb-dev commented Dec 19, 2022 •

edited

Loading

RubenPM-dev commented Jan 20, 2023 •

edited

Loading

tido64 commented Mar 17, 2023 •

edited

Loading

hwangJi-dev commented Nov 3, 2023 •

edited

Loading