RCTPackagerConnection.mm 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  1. /*
  2. * Copyright (c) Facebook, Inc. and its affiliates.
  3. *
  4. * This source code is licensed under the MIT license found in the
  5. * LICENSE file in the root directory of this source tree.
  6. */
  7. #import <React/RCTPackagerConnection.h>
  8. #import <objc/runtime.h>
  9. #import <algorithm>
  10. #import <vector>
  11. #import <React/RCTAssert.h>
  12. #import <React/RCTBridge.h>
  13. #import <React/RCTBundleURLProvider.h>
  14. #import <React/RCTConvert.h>
  15. #import <React/RCTDefines.h>
  16. #import <React/RCTLog.h>
  17. #import <React/RCTPackagerClient.h>
  18. #import <React/RCTReconnectingWebSocket.h>
  19. #import <React/RCTUtils.h>
  20. #if RCT_DEV
  21. #import <React/RCTSRWebSocket.h>
  22. @interface RCTPackagerConnection () <RCTReconnectingWebSocketDelegate>
  23. @end
  24. template <typename Handler>
  25. struct Registration {
  26. NSString *method;
  27. Handler handler;
  28. dispatch_queue_t queue;
  29. uint32_t token;
  30. };
  31. @implementation RCTPackagerConnection {
  32. std::mutex _mutex; // protects all ivars
  33. RCTReconnectingWebSocket *_socket;
  34. BOOL _socketConnected;
  35. NSString *_serverHostForSocket;
  36. id _bundleURLChangeObserver;
  37. uint32_t _nextToken;
  38. std::vector<Registration<RCTNotificationHandler>> _notificationRegistrations;
  39. std::vector<Registration<RCTRequestHandler>> _requestRegistrations;
  40. std::vector<Registration<RCTConnectedHandler>> _connectedRegistrations;
  41. }
  42. + (instancetype)sharedPackagerConnection
  43. {
  44. static RCTPackagerConnection *connection;
  45. static dispatch_once_t onceToken;
  46. dispatch_once(&onceToken, ^{
  47. connection = [RCTPackagerConnection new];
  48. });
  49. return connection;
  50. }
  51. - (instancetype)init
  52. {
  53. if (self = [super init]) {
  54. _nextToken = 1; // Prevent randomly erasing a handler if you pass a bogus 0 token
  55. _serverHostForSocket = [[RCTBundleURLProvider sharedSettings] packagerServerHost];
  56. _socket = socketForLocation(_serverHostForSocket);
  57. _socket.delegate = self;
  58. [_socket start];
  59. RCTPackagerConnection *const __weak weakSelf = self;
  60. _bundleURLChangeObserver =
  61. [[NSNotificationCenter defaultCenter] addObserverForName:RCTBundleURLProviderUpdatedNotification
  62. object:nil
  63. queue:[NSOperationQueue mainQueue]
  64. usingBlock:^(NSNotification *_Nonnull __unused note) {
  65. [weakSelf bundleURLSettingsChanged];
  66. }];
  67. }
  68. return self;
  69. }
  70. static RCTReconnectingWebSocket *socketForLocation(NSString *const serverHost)
  71. {
  72. NSURLComponents *const components = [NSURLComponents new];
  73. components.host = serverHost ?: @"localhost";
  74. components.scheme = @"http";
  75. components.port = @(kRCTBundleURLProviderDefaultPort);
  76. components.path = @"/message";
  77. components.queryItems = @[ [NSURLQueryItem queryItemWithName:@"role" value:@"ios"] ];
  78. static dispatch_queue_t queue;
  79. static dispatch_once_t onceToken;
  80. dispatch_once(&onceToken, ^{
  81. queue = dispatch_queue_create("com.facebook.RCTPackagerConnectionQueue", DISPATCH_QUEUE_SERIAL);
  82. });
  83. return [[RCTReconnectingWebSocket alloc] initWithURL:components.URL queue:queue];
  84. }
  85. - (void)stop
  86. {
  87. std::lock_guard<std::mutex> l(_mutex);
  88. if (_socket == nil) {
  89. // Already stopped
  90. return;
  91. }
  92. [[NSNotificationCenter defaultCenter] removeObserver:_bundleURLChangeObserver];
  93. _bundleURLChangeObserver = nil;
  94. _socketConnected = NO;
  95. [_socket stop];
  96. _socket = nil;
  97. _notificationRegistrations.clear();
  98. _requestRegistrations.clear();
  99. }
  100. - (void)bundleURLSettingsChanged
  101. {
  102. std::lock_guard<std::mutex> l(_mutex);
  103. if (_socket == nil) {
  104. return; // already stopped
  105. }
  106. NSString *const serverHost = [[RCTBundleURLProvider sharedSettings] packagerServerHost];
  107. if ([serverHost isEqual:_serverHostForSocket]) {
  108. return; // unchanged
  109. }
  110. _socket.delegate = nil;
  111. [_socket stop];
  112. _serverHostForSocket = serverHost;
  113. _socket = socketForLocation(serverHost);
  114. _socket.delegate = self;
  115. [_socket start];
  116. }
  117. - (RCTHandlerToken)addNotificationHandler:(RCTNotificationHandler)handler
  118. queue:(dispatch_queue_t)queue
  119. forMethod:(NSString *)method
  120. {
  121. std::lock_guard<std::mutex> l(_mutex);
  122. const auto token = _nextToken++;
  123. _notificationRegistrations.push_back({method, handler, queue, token});
  124. return token;
  125. }
  126. - (RCTHandlerToken)addRequestHandler:(RCTRequestHandler)handler
  127. queue:(dispatch_queue_t)queue
  128. forMethod:(NSString *)method
  129. {
  130. std::lock_guard<std::mutex> l(_mutex);
  131. const auto token = _nextToken++;
  132. _requestRegistrations.push_back({method, handler, queue, token});
  133. return token;
  134. }
  135. - (RCTHandlerToken)addConnectedHandler:(RCTConnectedHandler)handler queue:(dispatch_queue_t)queue
  136. {
  137. std::lock_guard<std::mutex> l(_mutex);
  138. if (_socketConnected) {
  139. dispatch_async(queue, ^{
  140. handler();
  141. });
  142. return 0; // _nextToken starts at 1, so 0 is a no-op token
  143. } else {
  144. const auto token = _nextToken++;
  145. _connectedRegistrations.push_back({nil, handler, queue, token});
  146. return token;
  147. }
  148. }
  149. - (void)removeHandler:(RCTHandlerToken)token
  150. {
  151. std::lock_guard<std::mutex> l(_mutex);
  152. eraseRegistrationsWithToken(_notificationRegistrations, token);
  153. eraseRegistrationsWithToken(_requestRegistrations, token);
  154. eraseRegistrationsWithToken(_connectedRegistrations, token);
  155. }
  156. template <typename Handler>
  157. static void eraseRegistrationsWithToken(std::vector<Registration<Handler>> &registrations, RCTHandlerToken token)
  158. {
  159. registrations.erase(
  160. std::remove_if(
  161. registrations.begin(), registrations.end(), [&token](const auto &reg) { return reg.token == token; }),
  162. registrations.end());
  163. }
  164. - (void)addHandler:(id<RCTPackagerClientMethod>)handler forMethod:(NSString *)method
  165. {
  166. dispatch_queue_t queue =
  167. [handler respondsToSelector:@selector(methodQueue)] ? [handler methodQueue] : dispatch_get_main_queue();
  168. [self
  169. addNotificationHandler:^(NSDictionary<NSString *, id> *notification) {
  170. [handler handleNotification:notification];
  171. }
  172. queue:queue
  173. forMethod:method];
  174. [self
  175. addRequestHandler:^(NSDictionary<NSString *, id> *request, RCTPackagerClientResponder *responder) {
  176. [handler handleRequest:request withResponder:responder];
  177. }
  178. queue:queue
  179. forMethod:method];
  180. }
  181. static BOOL isSupportedVersion(NSNumber *version)
  182. {
  183. NSArray<NSNumber *> *const kSupportedVersions = @[ @(RCT_PACKAGER_CLIENT_PROTOCOL_VERSION) ];
  184. return [kSupportedVersions containsObject:version];
  185. }
  186. #pragma mark - RCTReconnectingWebSocketDelegate
  187. - (void)reconnectingWebSocketDidOpen:(__unused RCTReconnectingWebSocket *)webSocket
  188. {
  189. std::vector<Registration<RCTConnectedHandler>> registrations;
  190. {
  191. std::lock_guard<std::mutex> l(_mutex);
  192. _socketConnected = YES;
  193. registrations = _connectedRegistrations;
  194. _connectedRegistrations.clear();
  195. }
  196. for (const auto &registration : registrations) {
  197. // Beware: don't capture the reference to handler in a dispatched block!
  198. RCTConnectedHandler handler = registration.handler;
  199. dispatch_async(registration.queue, ^{
  200. handler();
  201. });
  202. }
  203. }
  204. - (void)reconnectingWebSocket:(RCTReconnectingWebSocket *)webSocket didReceiveMessage:(id)message
  205. {
  206. NSError *error = nil;
  207. NSDictionary<NSString *, id> *msg = RCTJSONParse(message, &error);
  208. if (error) {
  209. RCTLogError(@"%@ failed to parse message with error %@\n<message>\n%@\n</message>", [self class], error, msg);
  210. return;
  211. }
  212. if (!isSupportedVersion(msg[@"version"])) {
  213. RCTLogError(@"%@ received message with not supported version %@", [self class], msg[@"version"]);
  214. return;
  215. }
  216. NSString *const method = msg[@"method"];
  217. NSDictionary<NSString *, id> *const params = msg[@"params"];
  218. id messageId = msg[@"id"];
  219. if (messageId) { // Request
  220. const std::vector<Registration<RCTRequestHandler>> registrations(
  221. registrationsWithMethod(_mutex, _requestRegistrations, method));
  222. if (registrations.empty()) {
  223. RCTLogError(@"No handler found for packager method %@", msg[@"method"]);
  224. [[[RCTPackagerClientResponder alloc] initWithId:messageId socket:webSocket]
  225. respondWithError:[NSString stringWithFormat:@"No handler found for packager method %@", msg[@"method"]]];
  226. } else {
  227. // If there are multiple matching request registrations, only one can win;
  228. // otherwise the packager would get multiple responses. Choose the last one.
  229. RCTRequestHandler handler = registrations.back().handler;
  230. dispatch_async(registrations.back().queue, ^{
  231. handler(params, [[RCTPackagerClientResponder alloc] initWithId:messageId socket:webSocket]);
  232. });
  233. }
  234. } else { // Notification
  235. const std::vector<Registration<RCTNotificationHandler>> registrations(
  236. registrationsWithMethod(_mutex, _notificationRegistrations, method));
  237. for (const auto &registration : registrations) {
  238. // Beware: don't capture the reference to handler in a dispatched block!
  239. RCTNotificationHandler handler = registration.handler;
  240. dispatch_async(registration.queue, ^{
  241. handler(params);
  242. });
  243. }
  244. }
  245. }
  246. - (void)reconnectingWebSocketDidClose:(__unused RCTReconnectingWebSocket *)webSocket
  247. {
  248. std::lock_guard<std::mutex> l(_mutex);
  249. _socketConnected = NO;
  250. }
  251. template <typename Handler>
  252. static std::vector<Registration<Handler>>
  253. registrationsWithMethod(std::mutex &mutex, const std::vector<Registration<Handler>> &registrations, NSString *method)
  254. {
  255. std::lock_guard<std::mutex> l(mutex); // Scope lock acquisition to prevent deadlock when calling out
  256. std::vector<Registration<Handler>> matches;
  257. for (const auto &reg : registrations) {
  258. if ([reg.method isEqual:method]) {
  259. matches.push_back(reg);
  260. }
  261. }
  262. return matches;
  263. }
  264. @end
  265. #endif