/** * Copyright (c) 2015-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 "RCTWebSocketExecutor.h" #import #import #import #import #import #import #import "RCTSRWebSocket.h" #if RCT_DEV // Debug executors are only supported in dev mode typedef void (^RCTWSMessageCallback)(NSError *error, NSDictionary *reply); @interface RCTWebSocketExecutor () @end @implementation RCTWebSocketExecutor { RCTSRWebSocket *_socket; dispatch_queue_t _jsQueue; NSMutableDictionary *_callbacks; dispatch_semaphore_t _socketOpenSemaphore; NSMutableDictionary *_injectedObjects; NSURL *_url; NSError *_setupError; } RCT_EXPORT_MODULE() @synthesize bridge = _bridge; - (instancetype)initWithURL:(NSURL *)URL { RCTAssertParam(URL); if ((self = [self init])) { _url = URL; } return self; } - (void)setUp { if (!_url) { NSInteger port = [[[_bridge bundleURL] port] integerValue] ?: 8081; NSString *host = [[_bridge bundleURL] host] ?: @"localhost"; NSString *URLString = [NSString stringWithFormat:@"http://%@:%lld/debugger-proxy?role=client", host, (long long)port]; _url = [RCTConvert NSURL:URLString]; } _jsQueue = dispatch_queue_create("com.facebook.react.WebSocketExecutor", DISPATCH_QUEUE_SERIAL); _socket = [[RCTSRWebSocket alloc] initWithURL:_url]; _socket.delegate = self; _callbacks = [NSMutableDictionary new]; _injectedObjects = [NSMutableDictionary new]; [_socket setDelegateDispatchQueue:_jsQueue]; NSURL *startDevToolsURL = [NSURL URLWithString:@"/launch-js-devtools" relativeToURL:_url]; NSURLSession *session = [NSURLSession sharedSession]; NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:[NSURLRequest requestWithURL:startDevToolsURL] completionHandler:^(NSData *data, NSURLResponse *response, NSError *error){}]; [dataTask resume]; if (![self connectToProxy]) { [self invalidate]; NSString *error = [NSString stringWithFormat:@"Connection to %@ timed out. Are you " "running node proxy? If you are running on the device, check if " "you have the right IP address in `RCTWebSocketExecutor.m`.", _url]; _setupError = RCTErrorWithMessage(error); RCTFatal(_setupError); return; } NSInteger retries = 3; BOOL runtimeIsReady = [self prepareJSRuntime]; while (!runtimeIsReady && retries > 0) { runtimeIsReady = [self prepareJSRuntime]; retries--; } if (!runtimeIsReady) { [self invalidate]; NSString *error = @"Runtime is not ready for debugging.\n " "- Make sure Packager server is running.\n" "- Make sure the JavaScript Debugger is running and not paused on a " "breakpoint or exception and try reloading again."; _setupError = RCTErrorWithMessage(error); RCTFatal(_setupError); return; } } - (BOOL)connectToProxy { _socketOpenSemaphore = dispatch_semaphore_create(0); [_socket open]; long connected = dispatch_semaphore_wait(_socketOpenSemaphore, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 10)); return connected == 0 && _socket.readyState == RCTSR_OPEN; } - (BOOL)prepareJSRuntime { __block NSError *initError; dispatch_semaphore_t s = dispatch_semaphore_create(0); [self sendMessage:@{@"method": @"prepareJSRuntime"} onReply:^(NSError *error, NSDictionary *reply) { initError = error; dispatch_semaphore_signal(s); }]; long runtimeIsReady = dispatch_semaphore_wait(s, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 5)); if (initError) { RCTLogInfo(@"Websocket runtime setup failed: %@", initError); } return runtimeIsReady == 0 && initError == nil; } - (void)webSocket:(RCTSRWebSocket *)webSocket didReceiveMessage:(id)message { NSError *error = nil; NSDictionary *reply = RCTJSONParse(message, &error); NSNumber *messageID = reply[@"replyID"]; RCTWSMessageCallback callback = _callbacks[messageID]; if (callback) { callback(error, reply); [_callbacks removeObjectForKey:messageID]; } } - (void)webSocketDidOpen:(RCTSRWebSocket *)webSocket { dispatch_semaphore_signal(_socketOpenSemaphore); } - (void)webSocket:(RCTSRWebSocket *)webSocket didFailWithError:(NSError *)error { dispatch_semaphore_signal(_socketOpenSemaphore); RCTLogInfo(@"WebSocket connection failed with error %@", error); } - (void)sendMessage:(NSDictionary *)message onReply:(RCTWSMessageCallback)callback { static NSUInteger lastID = 10000; if (_setupError) { callback(_setupError, nil); return; } dispatch_async(_jsQueue, ^{ if (!self.valid) { callback(RCTErrorWithMessage(@"Runtime is not ready for debugging. Make sure Packager server is running."), nil); return; } NSNumber *expectedID = @(lastID++); self->_callbacks[expectedID] = [callback copy]; NSMutableDictionary *messageWithID = [message mutableCopy]; messageWithID[@"id"] = expectedID; [self->_socket send:RCTJSONStringify(messageWithID, NULL)]; }); } - (void)executeApplicationScript:(NSData *)script sourceURL:(NSURL *)URL onComplete:(RCTJavaScriptCompleteBlock)onComplete { // Hack: the bridge transitions out of loading state as soon as this method returns, which prevents us // from completely invalidating the bridge and preventing an endless barage of RCTLog.logIfNoNativeHook // calls if the JS execution environment is broken. We therefore block this thread until this message has returned. dispatch_semaphore_t scriptSem = dispatch_semaphore_create(0); NSDictionary *message = @{ @"method": @"executeApplicationScript", @"url": RCTNullIfNil(URL.absoluteString), @"inject": _injectedObjects, }; [self sendMessage:message onReply:^(NSError *socketError, NSDictionary *reply) { if (socketError) { onComplete(socketError); } else { NSString *error = reply[@"error"]; onComplete(error ? RCTErrorWithMessage(error) : nil); } dispatch_semaphore_signal(scriptSem); }]; dispatch_semaphore_wait(scriptSem, DISPATCH_TIME_FOREVER); } - (void)flushedQueue:(RCTJavaScriptCallback)onComplete { [self _executeJSCall:@"flushedQueue" arguments:@[] callback:onComplete]; } - (void)callFunctionOnModule:(NSString *)module method:(NSString *)method arguments:(NSArray *)args callback:(RCTJavaScriptCallback)onComplete { [self _executeJSCall:@"callFunctionReturnFlushedQueue" arguments:@[module, method, args] callback:onComplete]; } - (void)invokeCallbackID:(NSNumber *)cbID arguments:(NSArray *)args callback:(RCTJavaScriptCallback)onComplete { [self _executeJSCall:@"invokeCallbackAndReturnFlushedQueue" arguments:@[cbID, args] callback:onComplete]; } - (void)_executeJSCall:(NSString *)method arguments:(NSArray *)arguments callback:(RCTJavaScriptCallback)onComplete { RCTAssert(onComplete != nil, @"callback was missing for exec JS call"); NSDictionary *message = @{ @"method": method, @"arguments": arguments }; [self sendMessage:message onReply:^(NSError *socketError, NSDictionary *reply) { if (socketError) { onComplete(nil, socketError); return; } NSError *jsonError; id result = RCTJSONParse(reply[@"result"], &jsonError); NSString *error = reply[@"error"]; onComplete(result, error ? RCTErrorWithMessage(error) : jsonError); }]; } - (void)injectJSONText:(NSString *)script asGlobalObjectNamed:(NSString *)objectName callback:(RCTJavaScriptCompleteBlock)onComplete { dispatch_async(_jsQueue, ^{ self->_injectedObjects[objectName] = script; onComplete(nil); }); } - (void)executeBlockOnJavaScriptQueue:(dispatch_block_t)block { RCTExecuteOnMainQueue(block); } - (void)executeAsyncBlockOnJavaScriptQueue:(dispatch_block_t)block { dispatch_async(dispatch_get_main_queue(), block); } - (void)invalidate { _socket.delegate = nil; [_socket closeWithCode:1000 reason:@"Invalidated"]; _socket = nil; } - (BOOL)isValid { return _socket != nil && _socket.readyState == RCTSR_OPEN; } - (void)dealloc { RCTAssert(!self.valid, @"-invalidate must be called before -dealloc"); } @end #endif