| 1 | | | import 'dart:async'; |
| 2 | | | |
| 3 | | | import 'package:logger/web.dart'; |
| 4 | | | |
| 5 | | | import '../build_options.dart'; |
| 6 | | | import '../_impl/xplat/_time_stamp.dart'; |
| 7 | | | import '../channel.dart'; |
| 8 | | | import '../exceptions/squadron_error.dart'; |
| 9 | | | import '../exceptions/squadron_exception.dart'; |
| 10 | | | import 'worker_message.dart'; |
| 11 | | | |
| 12 | | | /// [WorkerResponse]s are used to communicate from [Worker]s to clients and |
| 13 | | | /// carry a single piece of data. [Future]-based services simply return a |
| 14 | | | /// single [WorkerResponse] with the result. [Stream]ing services will return |
| 15 | | | /// one [WorkerResponse]s for each stream item and mmust send a |
| 16 | | | /// [WorkerResponse.closeStream] message to indicate completion. |
| 17 | | | /// [WorkerResponse]s can also send error messages and log events. |
| 18 | | 1 | extension type WorkerResponse._(List data) implements WorkerMessage { |
| 19 | | 1 | factory WorkerResponse.from(List data) { |
| 20 | | 2 | if (data.length != 5) { |
| 21 | | 0 | throw SquadronErrorImpl.create('Invalid worker response'); |
| 22 | | | } |
| 23 | | 1 | return WorkerResponse._(data); |
| 24 | | | } |
| 25 | | | |
| 26 | | | /// [WorkerResponse] with a valid [result]. If [result] is an [Iterable] but |
| 27 | | | /// not a [List], it will be converted to a [List] by [wrapInPlace]. |
| 28 | | 0 | factory WorkerResponse.ready([bool status = true]) => WorkerResponse._([ |
| 29 | | 0 | BuildOptions.withTravelTime ? Timestamp.now() : null, // 0 - travel time |
| 30 | | | status, // 1 - ready |
| 31 | | | null, // 2 - error |
| 32 | | | null, // 3 - end of stream |
| 33 | | | null, // 4 - log message |
| 34 | | | ]); |
| 35 | | | |
| 36 | | | /// [WorkerResponse] with a valid [result]. If [result] is an [Iterable] but |
| 37 | | | /// not a [List], it will be converted to a [List] by [wrapInPlace]. |
| 38 | | 3 | factory WorkerResponse.withResult(dynamic result) => WorkerResponse._([ |
| 39 | | 1 | BuildOptions.withTravelTime ? Timestamp.now() : null, // 0 - travel time |
| 40 | | | result, // 1 - result |
| 41 | | | null, // 2 - error |
| 42 | | | null, // 3 - end of stream |
| 43 | | | null, // 4 - log message |
| 44 | | | ]); |
| 45 | | | |
| 46 | | | /// [WorkerResponse] with an error message and an optional (string) [StackTrace]. |
| 47 | | 1 | factory WorkerResponse.withError(SquadronException exception, |
| 48 | | | [StackTrace? stackTrace]) => |
| 49 | | 2 | WorkerResponse._([ |
| 50 | | 1 | BuildOptions.withTravelTime ? Timestamp.now() : null, // 0 - travel time |
| 51 | | | null, // 1 - result |
| 52 | | | exception, // 2 - error |
| 53 | | | null, // 3 - end of stream |
| 54 | | | null, // 4 - log message |
| 55 | | | ]); |
| 56 | | | |
| 57 | | | /// [WorkerResponse] with log event information. |
| 58 | | 3 | factory WorkerResponse.log(LogEvent message) => WorkerResponse._([ |
| 59 | | 1 | BuildOptions.withTravelTime ? Timestamp.now() : null, // 0 - travel time |
| 60 | | | null, // 1 - result |
| 61 | | | null, // 2 - error |
| 62 | | | null, // 3 - end of stream |
| 63 | | | BuildOptions.withCrossWorkerLogging |
| 64 | | 1 | ? message.serialize() |
| 65 | | | : null, // 4 - log message |
| 66 | | | ]); |
| 67 | | | |
| 68 | | | /// Special [WorkerResponse] message to indicate the end of a stream. |
| 69 | | 3 | factory WorkerResponse.closeStream() => WorkerResponse._([ |
| 70 | | 1 | BuildOptions.withTravelTime ? Timestamp.now() : null, // 0 - travel time |
| 71 | | | null, // 1 - result |
| 72 | | | null, // 2 - error |
| 73 | | | true, // 3 - end of stream |
| 74 | | | null, // 4 - log message |
| 75 | | | ]); |
| 76 | | | |
| 77 | | | /// Flag indicating the end of the [Stream]ing operation. |
| 78 | | 2 | bool get endOfStream => data[_$endOfStream]; |
| 79 | | | |
| 80 | | | /// The [WorkerResponse] exception, if any. |
| 81 | | 2 | SquadronException? get error => data[_$error]; |
| 82 | | | |
| 83 | | | /// Retrieves the result associated to this [WorkerResponse]. If the |
| 84 | | | /// [WorkerResponse] contains an error, an the [error] exception is thrown. |
| 85 | | 1 | dynamic get result { |
| 86 | | 1 | final err = error; |
| 87 | | | if (err != null) { |
| 88 | | | throw err; |
| 89 | | | } else { |
| 90 | | 1 | return data[_$result]; |
| 91 | | | } |
| 92 | | | } |
| 93 | | | |
| 94 | | | /// In-place deserialization of a [WorkerResponse] sent by the worker. |
| 95 | | | /// Returns `false` if the message requires no further processing (currently |
| 96 | | | /// used for log messages only). |
| 97 | | 1 | bool unwrapInPlace(Channel channel) { |
| 98 | | 1 | unwrapTravelTime(); |
| 99 | | | final log = BuildOptions.withCrossWorkerLogging |
| 100 | | 2 | ? _LogEventSerializationExt.deserialize(data[_$log]) |
| 101 | | | : null; |
| 102 | | | if (log != null) { |
| 103 | | 4 | channel.logger?.log(log.level, log.message, |
| 104 | | 3 | time: log.time, error: log.error, stackTrace: log.stackTrace); |
| 105 | | | return false; |
| 106 | | | } else { |
| 107 | | 4 | data[_$error] = channel.exceptionManager.deserialize(data[_$error]); |
| 108 | | 1 | data[_$endOfStream] ??= false; |
| 109 | | | return true; |
| 110 | | | } |
| 111 | | | } |
| 112 | | | |
| 113 | | | /// In-place serialization of a [WorkerResponse]. |
| 114 | | 1 | void wrapInPlace() { |
| 115 | | 1 | final result = data[_$result]; |
| 116 | | 2 | if (result is Iterable && result is! List) { |
| 117 | | 2 | data[_$result] = result.toList(); |
| 118 | | | } |
| 119 | | 3 | data[_$error] = (data[_$error] as SquadronException?)?.serialize(); |
| 120 | | | } |
| 121 | | | } |
| 122 | | | |
| 123 | | | // 0 is reserved for travel time |
| 124 | | | const _$result = 1; |
| 125 | | | const _$error = 2; |
| 126 | | | const _$endOfStream = 3; |
| 127 | | | const _$log = 4; |
| 128 | | | |
| 129 | | | extension _LogEventSerializationExt on LogEvent { |
| 130 | | 2 | List serialize() => [ |
| 131 | | 2 | level.value, |
| 132 | | 2 | _stringify(message), |
| 133 | | 2 | Timestamp.from(time), |
| 134 | | 1 | error?.toString(), |
| 135 | | 1 | stackTrace?.toString(), |
| 136 | | | ]; |
| 137 | | | |
| 138 | | 1 | static LogEvent? deserialize(List? props) => (props == null) |
| 139 | | | ? null |
| 140 | | 1 | : LogEvent( |
| 141 | | 3 | _getLevel((props[0] as num?)?.toInt()), |
| 142 | | 1 | props[1], |
| 143 | | 3 | time: Timestamp.from(props[2] as num?)?.toDateTime(), |
| 144 | | 1 | error: props[3], |
| 145 | | 2 | stackTrace: SquadronException.loadStackTrace(props[4]), |
| 146 | | | ); |
| 147 | | | |
| 148 | | 2 | static final _levelMap = |
| 149 | | 5 | Map.fromEntries(Level.values.map((l) => MapEntry(l.value, l))); |
| 150 | | | |
| 151 | | 1 | static Level _getLevel(int? value) => |
| 152 | | 2 | _levelMap[value ?? Level.debug.value] ?? Level.debug; |
| 153 | | | |
| 154 | | 1 | static String? _stringify(dynamic message) { |
| 155 | | 1 | if (message is Function) { |
| 156 | | | try { |
| 157 | | 2 | return message().toString(); |
| 158 | | | } catch (ex) { |
| 159 | | 0 | return 'Deferred message failed with error: $ex'; |
| 160 | | | } |
| 161 | | | } else { |
| 162 | | 1 | return message.toString(); |
| 163 | | | } |
| 164 | | | } |
| 165 | | | } |