1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of Swift project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import Distributed
// ==== Fake Address -----------------------------------------------------------
public struct ActorAddress: Hashable, Sendable, Codable {
public let address: String
public init(parse address: String) {
self.address = address
}
public init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
self.address = try container.decode(String.self)
}
public func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
try container.encode(self.address)
}
}
// ==== Fake Systems -----------------------------------------------------------
public struct MissingRemoteCallVoidActorSystem: DistributedActorSystem {
public typealias ActorID = ActorAddress
public typealias InvocationDecoder = FakeInvocationDecoder
public typealias InvocationEncoder = FakeInvocationEncoder
public typealias SerializationRequirement = Codable
// just so that the struct does not become "trivial"
let someValue: String = ""
let someValue2: String = ""
let someValue3: String = ""
let someValue4: String = ""
init() {
print("Initialized new FakeActorSystem")
}
public func resolve<Act>(id: ActorID, as actorType: Act.Type) throws -> Act?
where Act: DistributedActor,
Act.ID == ActorID {
nil
}
public func assignID<Act>(_ actorType: Act.Type) -> ActorID
where Act: DistributedActor,
Act.ID == ActorID {
ActorAddress(parse: "xxx")
}
public func actorReady<Act>(_ actor: Act)
where Act: DistributedActor,
Act.ID == ActorID {
}
public func resignID(_ id: ActorID) {
}
public func makeInvocationEncoder() -> InvocationEncoder {
.init()
}
public func remoteCall<Act, Err, Res>(
on actor: Act,
target: RemoteCallTarget,
invocation invocationEncoder: inout InvocationEncoder,
throwing: Err.Type,
returning: Res.Type
) async throws -> Res
where Act: DistributedActor,
Act.ID == ActorID,
Err: Error,
Res: SerializationRequirement {
throw ExecuteDistributedTargetError(message: "\(#function) not implemented.")
}
// func remoteCallVoid<Act, Err>(
// on actor: Act,
// target: RemoteCallTarget,
// invocation invocationEncoder: inout InvocationEncoder,
// throwing: Err.Type
// ) async throws
// where Act: DistributedActor,
// Act.ID == ActorID,
// Err: Error {
// throw ExecuteDistributedTargetError(message: "\(#function) not implemented.")
// }
}
// ==== Fake Roundtrip Transport -----------------------------------------------
// TODO(distributed): not thread safe...
public final class FakeRoundtripActorSystem: DistributedActorSystem, @unchecked Sendable {
public typealias ActorID = ActorAddress
public typealias InvocationEncoder = FakeInvocationEncoder
public typealias InvocationDecoder = FakeInvocationDecoder
public typealias SerializationRequirement = Codable
var activeActors: [ActorID: any DistributedActor] = [:]
public init() {}
public func resolve<Act>(id: ActorID, as actorType: Act.Type)
throws -> Act? where Act: DistributedActor {
print("| resolve \(id) as remote // this system always resolves as remote")
return nil
}
public func assignID<Act>(_ actorType: Act.Type) -> ActorID
where Act: DistributedActor {
let id = ActorAddress(parse: "<unique-id>")
print("| assign id: \(id) for \(actorType)")
return id
}
public func actorReady<Act>(_ actor: Act)
where Act: DistributedActor,
Act.ID == ActorID {
print("| actor ready: \(actor)")
self.activeActors[actor.id] = actor
}
public func resignID(_ id: ActorID) {
print("X resign id: \(id)")
}
public func makeInvocationEncoder() -> InvocationEncoder {
.init()
}
private var remoteCallResult: Any? = nil
private var remoteCallError: Error? = nil
public func remoteCall<Act, Err, Res>(
on actor: Act,
target: RemoteCallTarget,
invocation: inout InvocationEncoder,
throwing errorType: Err.Type,
returning returnType: Res.Type
) async throws -> Res
where Act: DistributedActor,
Act.ID == ActorID,
Err: Error,
Res: SerializationRequirement {
print(" >> remoteCall: on:\(actor), target:\(target), invocation:\(invocation), throwing:\(String(reflecting: errorType)), returning:\(String(reflecting: returnType))")
guard let targetActor = activeActors[actor.id] else {
fatalError("Attempted to call mock 'roundtrip' on: \(actor.id) without active actor")
}
func doIt<A: DistributedActor>(active: A) async throws -> Res {
guard (actor.id) == active.id as! ActorID else {
fatalError("Attempted to call mock 'roundtrip' on unknown actor: \(actor.id), known: \(active.id)")
}
let resultHandler = FakeRoundtripResultHandler { value in
self.remoteCallResult = value
self.remoteCallError = nil
} onError: { error in
self.remoteCallResult = nil
self.remoteCallError = error
}
try await executeDistributedTarget(
on: active,
target: target,
invocationDecoder: invocation.makeDecoder(),
handler: resultHandler
)
switch (remoteCallResult, remoteCallError) {
case (.some(let value), nil):
print(" << remoteCall return: \(value)")
return remoteCallResult! as! Res
case (nil, .some(let error)):
print(" << remoteCall throw: \(error)")
throw error
default:
fatalError("No reply!")
}
}
return try await _openExistential(targetActor, do: doIt)
}
public func remoteCallVoid<Act, Err>(
on actor: Act,
target: RemoteCallTarget,
invocation: inout InvocationEncoder,
throwing errorType: Err.Type
) async throws
where Act: DistributedActor,
Act.ID == ActorID,
Err: Error {
print(" >> remoteCallVoid: on:\(actor), target:\(target), invocation:\(invocation), throwing:\(String(reflecting: errorType))")
guard let targetActor = activeActors[actor.id] else {
fatalError("Attempted to call mock 'roundtrip' on: \(actor.id) without active actor")
}
func doIt<A: DistributedActor>(active: A) async throws {
guard (actor.id) == active.id as! ActorID else {
fatalError("Attempted to call mock 'roundtrip' on unknown actor: \(actor.id), known: \(active.id)")
}
let resultHandler = FakeRoundtripResultHandler { value in
self.remoteCallResult = value
self.remoteCallError = nil
} onError: { error in
self.remoteCallResult = nil
self.remoteCallError = error
}
try await executeDistributedTarget(
on: active,
target: target,
invocationDecoder: invocation.makeDecoder(),
handler: resultHandler
)
switch (remoteCallResult, remoteCallError) {
case (.some, nil):
return
case (nil, .some(let error)):
print(" << remoteCall throw: \(error)")
throw error
default:
fatalError("No reply!")
}
}
try await _openExistential(targetActor, do: doIt)
}
}
public struct FakeInvocationEncoder : DistributedTargetInvocationEncoder {
public typealias SerializationRequirement = Codable
var genericSubs: [Any.Type] = []
var arguments: [Any] = []
var returnType: Any.Type? = nil
var errorType: Any.Type? = nil
public mutating func recordGenericSubstitution<T>(_ type: T.Type) throws {
print(" > encode generic sub: \(String(reflecting: type))")
genericSubs.append(type)
}
public mutating func recordArgument<Value: SerializationRequirement>(_ argument: RemoteCallArgument<Value>) throws {
print(" > encode argument name:\(argument.effectiveLabel), argument: \(argument.value)")
arguments.append(argument)
}
public mutating func recordErrorType<E: Error>(_ type: E.Type) throws {
print(" > encode error type: \(String(reflecting: type))")
self.errorType = type
}
public mutating func recordReturnType<R: SerializationRequirement>(_ type: R.Type) throws {
print(" > encode return type: \(String(reflecting: type))")
self.returnType = type
}
public mutating func doneRecording() throws {
print(" > done recording")
}
public func makeDecoder() -> FakeInvocationDecoder {
return .init(
args: arguments,
substitutions: genericSubs,
returnType: returnType,
errorType: errorType
)
}
}
// === decoding --------------------------------------------------------------
public class FakeInvocationDecoder : DistributedTargetInvocationDecoder {
public typealias SerializationRequirement = Codable
var genericSubs: [Any.Type] = []
var arguments: [Any] = []
var returnType: Any.Type? = nil
var errorType: Any.Type? = nil
var argumentIndex: Int = 0
fileprivate init(
args: [Any],
substitutions: [Any.Type] = [],
returnType: Any.Type? = nil,
errorType: Any.Type? = nil
) {
self.arguments = args
self.genericSubs = substitutions
self.returnType = returnType
self.errorType = errorType
}
public func decodeGenericSubstitutions() throws -> [Any.Type] {
print(" > decode generic subs: \(genericSubs)")
return genericSubs
}
public func decodeNextArgument<Argument: SerializationRequirement>() throws -> Argument {
guard argumentIndex < arguments.count else {
fatalError("Attempted to decode more arguments than stored! Index: \(argumentIndex), args: \(arguments)")
}
let anyArgument = arguments[argumentIndex]
guard let argument = anyArgument as? Argument else {
fatalError("Cannot cast argument\(anyArgument) to expected \(Argument.self)")
}
print(" > decode argument: \(argument)")
argumentIndex += 1
return argument
}
public func decodeErrorType() throws -> Any.Type? {
print(" > decode return type: \(errorType.map { String(describing: $0) } ?? "nil")")
return self.errorType
}
public func decodeReturnType() throws -> Any.Type? {
print(" > decode return type: \(returnType.map { String(describing: $0) } ?? "nil")")
return self.returnType
}
}
@available(SwiftStdlib 5.5, *)
public struct FakeRoundtripResultHandler: DistributedTargetInvocationResultHandler {
public typealias SerializationRequirement = Codable
let storeReturn: (any Any) -> Void
let storeError: (any Error) -> Void
init(_ storeReturn: @escaping (Any) -> Void, onError storeError: @escaping (Error) -> Void) {
self.storeReturn = storeReturn
self.storeError = storeError
}
// FIXME(distributed): can we return void here?
public func onReturn<Success: SerializationRequirement>(value: Success) async throws {
print(" << onReturn: \(value)")
storeReturn(value)
}
public func onThrow<Err: Error>(error: Err) async throws {
print(" << onThrow: \(error)")
storeError(error)
}
}
// ==== Helpers ----------------------------------------------------------------
@_silgen_name("swift_distributed_actor_is_remote")
func __isRemoteActor(_ actor: AnyObject) -> Bool
|