| 1 | | | import 'dart:async'; |
| 2 | | | |
| 3 | | | import 'package:logger/web.dart'; |
| 4 | | | |
| 5 | | | import '../../build_options.dart'; |
| 6 | | | import '../../exceptions/squadron_error.dart'; |
| 7 | | | import '../../exceptions/squadron_exception.dart'; |
| 8 | | | import '../../local_worker/local_worker.dart'; |
| 9 | | | import '../../service_installer.dart'; |
| 10 | | | import '../../tokens/_cancelation_token_ref.dart'; |
| 11 | | | import '../../tokens/_squadron_cancelation_token.dart'; |
| 12 | | | import '../../typedefs.dart'; |
| 13 | | | import '../../worker/worker_channel.dart'; |
| 14 | | | import '../../worker/worker_message.dart'; |
| 15 | | | import '../../worker/worker_request.dart'; |
| 16 | | | import '../../worker_service.dart'; |
| 17 | | | import '_internal_logger.dart'; |
| 18 | | | |
| 19 | | | class WorkerRunner { |
| 20 | | | /// Constructs a new worker runner. |
| 21 | | 1 | WorkerRunner(this._terminate); |
| 22 | | | |
| 23 | | | void Function(WorkerRunner) _terminate; |
| 24 | | | |
| 25 | | | final internalLogger = |
| 26 | | | BuildOptions.withInternalLogging ? InternalLogger() : null; |
| 27 | | | |
| 28 | | | WorkerService? _service; |
| 29 | | | OperationsMap? _operations; |
| 30 | | | |
| 31 | | | final _cancelTokens = <String, CancelationTokenReference>{}; |
| 32 | | | |
| 33 | | | bool _terminationRequested = false; |
| 34 | | | int _executing = 0; |
| 35 | | | |
| 36 | | | final _streamCancelers = <StreamId, StreamCanceler>{}; |
| 37 | | | |
| 38 | | | void Function(OutputEvent)? _logForwarder; |
| 39 | | | |
| 40 | | | /// Constructs a new worker runner for a [localWorker]. |
| 41 | | 1 | factory WorkerRunner.local(LocalWorker localWorker) { |
| 42 | | 1 | final runner = WorkerRunner((r) { |
| 43 | | 0 | r.internalLogger?.t('Terminating local Worker'); |
| 44 | | 0 | r._service = null; |
| 45 | | 0 | r._operations = null; |
| 46 | | | }); |
| 47 | | 2 | _checkOperations(localWorker.operations); |
| 48 | | 1 | runner._service = localWorker; |
| 49 | | 2 | runner._operations = localWorker.operations; |
| 50 | | | return runner; |
| 51 | | | } |
| 52 | | | |
| 53 | | 1 | static void _checkOperations(OperationsMap ops) { |
| 54 | | 5 | final invalidKeys = ops.keys.where((k) => k <= 0).toList(); |
| 55 | | 1 | if (invalidKeys.isNotEmpty) { |
| 56 | | 1 | throw SquadronErrorImpl.create( |
| 57 | | 4 | 'Invalid command identifier${(invalidKeys.length > 1) ? 's' : ''} in service operations map: ${invalidKeys.join(', ')}. Command ids must be positive.', |
| 58 | | | ); |
| 59 | | | } |
| 60 | | | } |
| 61 | | | |
| 62 | | | /// Called by the platform worker upon startup, in response to a start |
| 63 | | | /// [WorkerRequest]. [channelInfo] is an opaque object sent back from the |
| 64 | | | /// platform worker to the Squadron [Worker] and used to communicate with the |
| 65 | | | /// platform worker. Typically, [channelInfo] would be a [SendPort] (native) |
| 66 | | | /// or a [MessagePort] (browser). [initializer] is called to build the |
| 67 | | | /// [WorkerService] associated to the worker. The runner's [_service] map |
| 68 | | | /// will be set with operations from the service. |
| 69 | | 1 | void connect(WorkerRequest? startRequest, PlatformChannel channelInfo, |
| 70 | | | WorkerInitializer initializer) async { |
| 71 | | | late final WorkerChannel? channel; |
| 72 | | | try { |
| 73 | | 2 | startRequest?.unwrapInPlace(internalLogger); |
| 74 | | 1 | channel = startRequest?.channel; |
| 75 | | | |
| 76 | | | if (startRequest == null) { |
| 77 | | 1 | throw SquadronErrorImpl.create('Missing connection request'); |
| 78 | | | } else if (channel == null) { |
| 79 | | 0 | throw SquadronErrorImpl.create('Missing client for connection request'); |
| 80 | | | } |
| 81 | | | |
| 82 | | 1 | if (BuildOptions.withCrossWorkerLogging && _logForwarder == null) { |
| 83 | | 1 | final logger = channel.log; |
| 84 | | 4 | _logForwarder = (event) => logger(event.origin); |
| 85 | | 2 | Logger.addOutputListener(_logForwarder!); |
| 86 | | | } |
| 87 | | | |
| 88 | | 1 | if (!startRequest.isConnection) { |
| 89 | | 0 | throw SquadronErrorImpl.create('Connection request expected'); |
| 90 | | 2 | } else if (_service != null || _operations != null) { |
| 91 | | 0 | throw SquadronErrorImpl.create('Already connected'); |
| 92 | | | } |
| 93 | | | |
| 94 | | 1 | var service = initializer(startRequest); |
| 95 | | 1 | if (service is Future<WorkerService>) service = await service; |
| 96 | | | service as WorkerService; |
| 97 | | 2 | _checkOperations(service.operations); |
| 98 | | 1 | _service = service; |
| 99 | | 2 | _operations = service.operations; |
| 100 | | | |
| 101 | | 1 | channel.connect(channelInfo); |
| 102 | | | |
| 103 | | 1 | if (service is ServiceInstaller) { |
| 104 | | 2 | _installCompleter = Completer<void>(); |
| 105 | | | try { |
| 106 | | 1 | final result = (service as ServiceInstaller).install(); |
| 107 | | 1 | if (result is Future) await result; |
| 108 | | | } catch (ex, st) { |
| 109 | | 4 | internalLogger?.e(() => 'Service installation failed: $ex'); |
| 110 | | 1 | channel.error(ex, st); |
| 111 | | 1 | channel.closeStream(); |
| 112 | | 2 | _installError = SquadronException.from(ex, st); |
| 113 | | | } finally { |
| 114 | | 2 | _installCompleter?.complete(); |
| 115 | | | } |
| 116 | | | } |
| 117 | | | } catch (ex, st) { |
| 118 | | 4 | internalLogger?.e(() => 'Connection failed: $ex'); |
| 119 | | 1 | channel?.error(ex, st); |
| 120 | | 1 | _exit(); |
| 121 | | | } |
| 122 | | | } |
| 123 | | | |
| 124 | | | Completer<void>? _installCompleter; |
| 125 | | | SquadronException? _installError; |
| 126 | | | |
| 127 | | | /// [WorkerRequest] handler dispatching commands according to the |
| 128 | | | /// [_service] map. Make sure this method doesn't throw. |
| 129 | | 1 | void processRequest(WorkerRequest request) async { |
| 130 | | | WorkerChannel? channel; |
| 131 | | | try { |
| 132 | | 2 | request.unwrapInPlace(internalLogger); |
| 133 | | 1 | channel = request.channel; |
| 134 | | | |
| 135 | | 1 | if (request.isTermination) { |
| 136 | | | // terminate the worker |
| 137 | | 1 | return _shutdown(); |
| 138 | | | } |
| 139 | | | |
| 140 | | | // check installation result if necessary |
| 141 | | 2 | final pendingInstallation = _installCompleter?.future; |
| 142 | | | if (pendingInstallation != null) { |
| 143 | | | await pendingInstallation; |
| 144 | | 1 | _installCompleter = null; |
| 145 | | | } |
| 146 | | | |
| 147 | | 1 | if (_installError != null) { |
| 148 | | | // service installation failed |
| 149 | | 1 | throw _installError!; |
| 150 | | | } |
| 151 | | | |
| 152 | | | // ==== these requests do not send a response ==== |
| 153 | | | |
| 154 | | 1 | if (request.isTokenCancelation) { |
| 155 | | | // cancel a token |
| 156 | | 1 | final token = request.cancelToken!; |
| 157 | | 2 | return _getTokenRef(token).update(token); |
| 158 | | 1 | } else if (request.isStreamCancelation) { |
| 159 | | | // cancel a stream |
| 160 | | 3 | final canceler = _streamCancelers[request.streamId]; |
| 161 | | 1 | return canceler?.call(); |
| 162 | | | } |
| 163 | | | |
| 164 | | | // make sure the worker is connected |
| 165 | | | |
| 166 | | 1 | if (request.isConnection) { |
| 167 | | | // connection requests are handled by connect(). |
| 168 | | 0 | throw SquadronErrorImpl.create( |
| 169 | | 0 | 'Unexpected connection request: $request'); |
| 170 | | | } |
| 171 | | | |
| 172 | | | // find the operation matching the request command |
| 173 | | 3 | final cmd = request.command, op = _operations![cmd]; |
| 174 | | | if (op == null) { |
| 175 | | | // unknown command, or commands are not available yet (maybe connect() wasn't called or awaited) |
| 176 | | 2 | throw SquadronErrorImpl.create((_operations == null) |
| 177 | | | ? 'Worker service is not ready' |
| 178 | | 1 | : 'Unknown command: $cmd'); |
| 179 | | | } |
| 180 | | | |
| 181 | | | // ==== other requests require a client to send the response ==== |
| 182 | | | |
| 183 | | | if (channel == null) { |
| 184 | | 0 | throw SquadronErrorImpl.create('Missing client for request: $request'); |
| 185 | | | } |
| 186 | | | |
| 187 | | 1 | final token = request.cancelToken; |
| 188 | | 1 | token?.throwIfCanceled(); |
| 189 | | | |
| 190 | | | // start monitoring execution |
| 191 | | 1 | final tokenRef = _begin(request); |
| 192 | | | try { |
| 193 | | | // process |
| 194 | | 1 | var result = op(request); |
| 195 | | 1 | if (result is Future) { |
| 196 | | | result = await result; |
| 197 | | | } |
| 198 | | | |
| 199 | | 1 | final reply = request.reply!; |
| 200 | | 2 | if (result is Stream && channel.canStream(result)) { |
| 201 | | | // result is a stream: forward data to the client |
| 202 | | 1 | final replyWithError = channel.error; |
| 203 | | 1 | void $postError(Object exception, [StackTrace? stackTrace]) { |
| 204 | | 1 | replyWithError(exception, stackTrace, cmd); |
| 205 | | | } |
| 206 | | | |
| 207 | | 1 | void post(data) { |
| 208 | | | try { |
| 209 | | 1 | reply(data); |
| 210 | | | } catch (ex, st) { |
| 211 | | 0 | $postError(ex, st); |
| 212 | | | } |
| 213 | | | } |
| 214 | | | |
| 215 | | 1 | await _pipe(result, channel, post, $postError, token); |
| 216 | | | } else { |
| 217 | | | // result is a value: send to the client |
| 218 | | 1 | reply(result); |
| 219 | | | } |
| 220 | | | } finally { |
| 221 | | | // stop monitoring execution |
| 222 | | 1 | _done(tokenRef); |
| 223 | | | } |
| 224 | | | } catch (ex, st) { |
| 225 | | | if (channel != null) { |
| 226 | | 2 | channel.error(ex, st, request.command); |
| 227 | | | } else { |
| 228 | | 3 | internalLogger?.e('Unhandled error: $ex'); |
| 229 | | | } |
| 230 | | | } |
| 231 | | | } |
| 232 | | | |
| 233 | | 1 | CancelationTokenReference _getTokenRef(SquadronCancelationToken? token) => |
| 234 | | | (token == null) |
| 235 | | 1 | ? CancelationTokenReference.noToken |
| 236 | | 2 | : _cancelTokens.putIfAbsent( |
| 237 | | 4 | token.id, () => CancelationTokenReference(token.id)); |
| 238 | | | |
| 239 | | | /// Starts monitoring execution of this [request]. If the request contains a |
| 240 | | | /// cancelation token, it is overridden with a [CancelationTokenReference] |
| 241 | | | /// and this reference is returned to the sender. Otherwise, returns |
| 242 | | | /// [CancelationTokenReference.noToken]. |
| 243 | | 1 | CancelationTokenReference _begin(WorkerRequest request) { |
| 244 | | 2 | _executing++; |
| 245 | | 2 | final token = _getTokenRef(request.cancelToken); |
| 246 | | 1 | token.usedBy(request); |
| 247 | | | return token; |
| 248 | | | } |
| 249 | | | |
| 250 | | | /// Stops monitoring execution and releases the [tokenRef]. |
| 251 | | 1 | void _done(CancelationTokenReference tokenRef) { |
| 252 | | 1 | tokenRef.release(); |
| 253 | | 2 | if (tokenRef.refCount == 0) { |
| 254 | | 3 | _cancelTokens.remove(tokenRef.id); |
| 255 | | | } |
| 256 | | 2 | _executing--; |
| 257 | | 3 | if (_terminationRequested && _executing == 0) { |
| 258 | | 1 | _unmount(); |
| 259 | | | } |
| 260 | | | } |
| 261 | | | |
| 262 | | | /// Forwards stream events to client. |
| 263 | | 1 | Future<void> _pipe( |
| 264 | | | Stream<dynamic> stream, |
| 265 | | | WorkerChannel channel, |
| 266 | | | void Function(dynamic) post, |
| 267 | | | void Function(Object exception, [StackTrace? stackTrace]) postError, |
| 268 | | | SquadronCancelationToken? token, |
| 269 | | | ) { |
| 270 | | | late final StreamSubscription subscription; |
| 271 | | 1 | final done = Completer(); |
| 272 | | | |
| 273 | | | late final StreamId streamId; |
| 274 | | | |
| 275 | | | // send endOfStream to client |
| 276 | | 1 | Future<void> onDone() { |
| 277 | | 1 | _unregisterStreamCanceler(streamId); |
| 278 | | 1 | channel.closeStream(); |
| 279 | | 3 | return subscription.cancel().whenComplete(done.complete); |
| 280 | | | } |
| 281 | | | |
| 282 | | | final bool Function() checkToken; |
| 283 | | | if (token == null) { |
| 284 | | 1 | checkToken = () => true; |
| 285 | | | } else { |
| 286 | | 1 | checkToken = () { |
| 287 | | 1 | final ex = token.exception; |
| 288 | | | if (ex != null) { |
| 289 | | 0 | postError(ex); |
| 290 | | 0 | onDone(); |
| 291 | | | } |
| 292 | | | return (ex == null); |
| 293 | | | }; |
| 294 | | | } |
| 295 | | | |
| 296 | | | // register stream canceler callback and connect stream with client |
| 297 | | 1 | streamId = _registerStreamCanceler(onDone); |
| 298 | | 1 | post(streamId); |
| 299 | | 1 | if (checkToken()) { |
| 300 | | | // start forwarding messages to the client |
| 301 | | 1 | subscription = stream.listen( |
| 302 | | 1 | (data) { |
| 303 | | 2 | if (checkToken()) post(data); |
| 304 | | | }, |
| 305 | | 1 | onError: (ex, st) { |
| 306 | | 2 | if (checkToken()) postError(ex, st); |
| 307 | | | }, |
| 308 | | | onDone: onDone, |
| 309 | | | cancelOnError: false, |
| 310 | | | ); |
| 311 | | | } |
| 312 | | | |
| 313 | | 1 | return done.future; |
| 314 | | | } |
| 315 | | | |
| 316 | | | /// Assigns a stream ID to the stream canceler callback and registers the |
| 317 | | | /// callback. |
| 318 | | 1 | StreamId _registerStreamCanceler(StreamCanceler canceler) { |
| 319 | | 1 | final streamId = StreamId.next(); |
| 320 | | 2 | _streamCancelers[streamId] = canceler; |
| 321 | | | return streamId; |
| 322 | | | } |
| 323 | | | |
| 324 | | | /// Unregisters the stream canceled callback associated to the [streamId]. |
| 325 | | 1 | void _unregisterStreamCanceler(StreamId streamId) { |
| 326 | | 2 | _streamCancelers.remove(streamId); |
| 327 | | | } |
| 328 | | | |
| 329 | | | /// Terminates the worker if there is no pending execution. Otherwise, marks |
| 330 | | | /// the worker as terminating and termination will be effective when all |
| 331 | | | /// pending executions have completed. |
| 332 | | 1 | void _shutdown() { |
| 333 | | 1 | _terminationRequested = true; |
| 334 | | 2 | if (_executing == 0) { |
| 335 | | 1 | _unmount(); |
| 336 | | | } |
| 337 | | | } |
| 338 | | | |
| 339 | | | // should not throw |
| 340 | | 1 | void _unmount() async { |
| 341 | | | try { |
| 342 | | | // uninstall the service if necessary |
| 343 | | 2 | if (_service is ServiceInstaller) { |
| 344 | | | // check installation result |
| 345 | | 1 | final pendingInstallation = _installCompleter?.future; |
| 346 | | | if (pendingInstallation != null) { |
| 347 | | | await pendingInstallation; |
| 348 | | 0 | _installCompleter = null; |
| 349 | | | } |
| 350 | | 1 | if (_installError == null) { |
| 351 | | | // uninstall iif the service installed succesfuly |
| 352 | | 2 | await (_service as ServiceInstaller).uninstall(); |
| 353 | | | } |
| 354 | | | } |
| 355 | | | } catch (ex) { |
| 356 | | 3 | internalLogger?.e('Service uninstallation failed with error: $ex'); |
| 357 | | | } finally { |
| 358 | | 1 | _exit(); |
| 359 | | | } |
| 360 | | | } |
| 361 | | | |
| 362 | | | // should not throw |
| 363 | | 1 | void _exit() { |
| 364 | | | try { |
| 365 | | 2 | _terminate(this); |
| 366 | | | } catch (ex) { |
| 367 | | 0 | internalLogger?.e('Worker termination failed with error: $ex'); |
| 368 | | | } |
| 369 | | 1 | if (BuildOptions.withCrossWorkerLogging && _logForwarder != null) { |
| 370 | | 2 | Logger.removeOutputListener(_logForwarder!); |
| 371 | | | } |
| 372 | | | } |
| 373 | | | } |