Skip to content

Commit 90c140c

Browse files
ktosoktoso
committed
[Distributed] Also prevent mutating remoteCall impls
1 parent 6a0ea41 commit 90c140c

File tree

4 files changed

+171
-28
lines changed

4 files changed

+171
-28
lines changed

‎hello.fixit

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[
2+
{
3+
"file": "/Users/ktoso/code/swift-distributed-actors-wwdc2022/Source/Step 0 Local Only/Shared/Sources/TicTacFishShared/Game/GameState.swift",
4+
"offset": 150,
5+
"text": ", Codable",
6+
},
7+
{
8+
"file": "/Users/ktoso/code/swift-distributed-actors-wwdc2022/Source/Step 0 Local Only/Shared/Sources/TicTacFishShared/Game/GameState.swift",
9+
"offset": 150,
10+
"text": ", Codable",
11+
},
12+
]

‎lib/AST/DistributedDecl.cpp

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,11 @@ bool AbstractFunctionDecl::isDistributedActorSystemRemoteCall(bool isVoidReturn)
431431
return false;
432432
}
433433

434+
auto *func = dyn_cast<FuncDecl>(this);
435+
if (!func) {
436+
return false;
437+
}
438+
434439
// === Structural Checks
435440
// -- Must be throwing
436441
if (!hasThrows()) {
@@ -442,6 +447,11 @@ bool AbstractFunctionDecl::isDistributedActorSystemRemoteCall(bool isVoidReturn)
442447
return false;
443448
}
444449

450+
// -- Must not be mutating, use classes to implement a system instead
451+
if (func->isMutating()) {
452+
return false;
453+
}
454+
445455
// === Check generics
446456
if (!isGeneric()) {
447457
return false;

‎lib/Sema/TypeCheckDistributed.cpp

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ bool swift::checkDistributedActorSystemAdHocProtocolRequirements(
247247
decl->getDescriptiveKind(), decl->getName(), identifier);
248248
decl->diagnose(
249249
diag::note_distributed_actor_system_conformance_missing_adhoc_requirement,
250-
decl->getName(), identifier,
250+
Proto->getName(), identifier,
251251
"func remoteCall<Act, Err, Res>(\n"
252252
" on actor: Act,\n"
253253
" target: RemoteCallTarget,\n"
@@ -274,7 +274,7 @@ bool swift::checkDistributedActorSystemAdHocProtocolRequirements(
274274
decl->getDescriptiveKind(), decl->getName(), identifier);
275275
decl->diagnose(
276276
diag::note_distributed_actor_system_conformance_missing_adhoc_requirement,
277-
decl->getName(), identifier,
277+
Proto->getName(), identifier,
278278
"func remoteCallVoid<Act, Err>(\n"
279279
" on actor: Act,\n"
280280
" target: RemoteCallTarget,\n"
@@ -303,7 +303,7 @@ bool swift::checkDistributedActorSystemAdHocProtocolRequirements(
303303
diag::distributed_actor_system_conformance_missing_adhoc_requirement,
304304
decl->getDescriptiveKind(), decl->getName(), identifier);
305305
decl->diagnose(diag::note_distributed_actor_system_conformance_missing_adhoc_requirement,
306-
decl->getName(), identifier,
306+
Proto->getName(), identifier,
307307
"mutating func recordArgument<Value: SerializationRequirement>(_ argument: RemoteCallArgument<Value>) throws\n");
308308
anyMissingAdHocRequirements = true;
309309
}
@@ -318,7 +318,7 @@ bool swift::checkDistributedActorSystemAdHocProtocolRequirements(
318318
diag::distributed_actor_system_conformance_missing_adhoc_requirement,
319319
decl->getDescriptiveKind(), decl->getName(), identifier);
320320
decl->diagnose(diag::note_distributed_actor_system_conformance_missing_adhoc_requirement,
321-
decl->getName(), identifier,
321+
Proto->getName(), identifier,
322322
"mutating func recordReturnType<Res: SerializationRequirement>(_ resultType: Res.Type) throws\n");
323323
anyMissingAdHocRequirements = true;
324324
}
@@ -339,7 +339,7 @@ bool swift::checkDistributedActorSystemAdHocProtocolRequirements(
339339
diag::distributed_actor_system_conformance_missing_adhoc_requirement,
340340
decl->getDescriptiveKind(), decl->getName(), identifier);
341341
decl->diagnose(diag::note_distributed_actor_system_conformance_missing_adhoc_requirement,
342-
decl->getName(), identifier,
342+
Proto->getName(), identifier,
343343
"mutating func decodeNextArgument<Argument: SerializationRequirement>() throws -> Argument\n");
344344
anyMissingAdHocRequirements = true;
345345
}
@@ -360,10 +360,9 @@ bool swift::checkDistributedActorSystemAdHocProtocolRequirements(
360360
diag::distributed_actor_system_conformance_missing_adhoc_requirement,
361361
decl->getDescriptiveKind(), decl->getName(), identifier);
362362
decl->diagnose(
363-
diag::
364-
note_distributed_actor_system_conformance_missing_adhoc_requirement,
365-
decl->getName(), identifier,
366-
"mutating func onReturn<Success: SerializationRequirement>(value: "
363+
diag::note_distributed_actor_system_conformance_missing_adhoc_requirement,
364+
Proto->getName(), identifier,
365+
"func onReturn<Success: SerializationRequirement>(value: "
367366
"Success) async throws\n");
368367
anyMissingAdHocRequirements = true;
369368
}

‎test/Distributed/distributed_actor_system_missing_adhoc_requirement_impls.swift

Lines changed: 141 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ import Distributed
88

99
struct MissingRemoteCall: DistributedActorSystem {
1010
// expected-error@-1{{struct 'MissingRemoteCall' is missing witness for protocol requirement 'remoteCall'}}
11-
// expected-note@-2{{protocol 'MissingRemoteCall' requires function 'remoteCall' with signature:}}
11+
// expected-note@-2{{protocol 'DistributedActorSystem' requires function 'remoteCall' with signature:}}
1212

1313
// expected-error@-4{{struct 'MissingRemoteCall' is missing witness for protocol requirement 'remoteCallVoid'}}
14-
// expected-note@-5{{protocol 'MissingRemoteCall' requires function 'remoteCallVoid' with signature:}}
14+
// expected-note@-5{{protocol 'DistributedActorSystem' requires function 'remoteCallVoid' with signature:}}
1515

1616
typealias ActorID = ActorAddress
1717
typealias InvocationDecoder = FakeInvocationDecoder
@@ -41,6 +41,128 @@ struct MissingRemoteCall: DistributedActorSystem {
4141
}
4242
}
4343

44+
struct RemoteCallMutating: DistributedActorSystem {
45+
// expected-error@-1{{struct 'RemoteCallMutating' is missing witness for protocol requirement 'remoteCall'}}
46+
// expected-note@-2{{protocol 'DistributedActorSystem' requires function 'remoteCall' with signature:}}
47+
48+
// expected-error@-4{{struct 'RemoteCallMutating' is missing witness for protocol requirement 'remoteCallVoid'}}
49+
// expected-note@-5{{protocol 'DistributedActorSystem' requires function 'remoteCallVoid' with signature:}}
50+
51+
typealias ActorID = ActorAddress
52+
typealias InvocationDecoder = FakeInvocationDecoder
53+
typealias InvocationEncoder = FakeInvocationEncoder
54+
typealias SerializationRequirement = Codable
55+
typealias ResultHandler = FakeResultHandler
56+
57+
func resolve<Act>(id: ActorID, as actorType: Act.Type)
58+
throws -> Act? where Act: DistributedActor {
59+
return nil
60+
}
61+
62+
func assignID<Act>(_ actorType: Act.Type) -> ActorID
63+
where Act: DistributedActor {
64+
ActorAddress(parse: "fake://123")
65+
}
66+
67+
func actorReady<Act>(_ actor: Act)
68+
where Act: DistributedActor,
69+
Act.ID == ActorID {
70+
}
71+
72+
func resignID(_ id: ActorID) {
73+
}
74+
75+
mutating func remoteCall<Act, Err, Res>(
76+
on actor: Act,
77+
target: RemoteCallTarget,
78+
invocation: inout InvocationEncoder,
79+
throwing: Err.Type,
80+
returning: Res.Type
81+
) async throws -> Res
82+
where Act: DistributedActor,
83+
Act.ID == ActorID,
84+
Err: Error,
85+
Res: SerializationRequirement {
86+
fatalError("NOT IMPLEMENTED \(#function)")
87+
}
88+
89+
mutating func remoteCallVoid<Act, Err>(
90+
on actor: Act,
91+
target: RemoteCallTarget,
92+
invocation: inout InvocationEncoder,
93+
throwing: Err.Type
94+
) async throws
95+
where Act: DistributedActor,
96+
Act.ID == ActorID,
97+
Err: Error {
98+
fatalError("NOT IMPLEMENTED \(#function)")
99+
}
100+
101+
func makeInvocationEncoder() -> InvocationEncoder {
102+
}
103+
}
104+
105+
struct MissingRemoteCall_missingInout_on_encoder: DistributedActorSystem {
106+
// expected-error@-1{{struct 'MissingRemoteCall_missingInout_on_encoder' is missing witness for protocol requirement 'remoteCall'}}
107+
// expected-note@-2{{protocol 'DistributedActorSystem' requires function 'remoteCall' with signature:}}
108+
109+
// expected-error@-4{{struct 'MissingRemoteCall_missingInout_on_encoder' is missing witness for protocol requirement 'remoteCallVoid'}}
110+
// expected-note@-5{{protocol 'DistributedActorSystem' requires function 'remoteCallVoid' with signature:}}
111+
112+
typealias ActorID = ActorAddress
113+
typealias InvocationDecoder = FakeInvocationDecoder
114+
typealias InvocationEncoder = FakeInvocationEncoder
115+
typealias SerializationRequirement = Codable
116+
typealias ResultHandler = FakeResultHandler
117+
118+
func resolve<Act>(id: ActorID, as actorType: Act.Type)
119+
throws -> Act? where Act: DistributedActor {
120+
return nil
121+
}
122+
123+
func assignID<Act>(_ actorType: Act.Type) -> ActorID
124+
where Act: DistributedActor {
125+
ActorAddress(parse: "fake://123")
126+
}
127+
128+
func actorReady<Act>(_ actor: Act)
129+
where Act: DistributedActor,
130+
Act.ID == ActorID {
131+
}
132+
133+
func resignID(_ id: ActorID) {
134+
}
135+
136+
func remoteCall<Act, Err, Res>(
137+
on actor: Act,
138+
target: RemoteCallTarget,
139+
invocation: InvocationEncoder, // MISSING 'inout'
140+
throwing: Err.Type,
141+
returning: Res.Type
142+
) async throws -> Res
143+
where Act: DistributedActor,
144+
Act.ID == ActorID,
145+
Err: Error,
146+
Res: SerializationRequirement {
147+
fatalError("NOT IMPLEMENTED \(#function)")
148+
}
149+
150+
func remoteCallVoid<Act, Err>(
151+
on actor: Act,
152+
target: RemoteCallTarget,
153+
invocation: InvocationEncoder, // MISSING 'inout'
154+
throwing: Err.Type
155+
) async throws
156+
where Act: DistributedActor,
157+
Act.ID == ActorID,
158+
Err: Error {
159+
fatalError("NOT IMPLEMENTED \(#function)")
160+
}
161+
162+
func makeInvocationEncoder() -> InvocationEncoder {
163+
}
164+
}
165+
44166
struct MissingRemoteCall_missing_makeInvocationEncoder: DistributedActorSystem {
45167
// expected-error@-1{{type 'MissingRemoteCall_missing_makeInvocationEncoder' does not conform to protocol 'DistributedActorSystem'}}
46168

@@ -99,10 +221,10 @@ struct MissingRemoteCall_missing_makeInvocationEncoder: DistributedActorSystem {
99221

100222
struct Error_wrongReturn: DistributedActorSystem {
101223
// expected-error@-1{{struct 'Error_wrongReturn' is missing witness for protocol requirement 'remoteCall'}}
102-
// expected-note@-2{{protocol 'Error_wrongReturn' requires function 'remoteCall' with signature:}}
224+
// expected-note@-2{{protocol 'DistributedActorSystem' requires function 'remoteCall' with signature:}}
103225

104226
// expected-error@-4{{struct 'Error_wrongReturn' is missing witness for protocol requirement 'remoteCallVoid'}}
105-
// expected-note@-5{{protocol 'Error_wrongReturn' requires function 'remoteCallVoid' with signature:}}
227+
// expected-note@-5{{protocol 'DistributedActorSystem' requires function 'remoteCallVoid' with signature:}}
106228

107229
typealias ActorID = ActorAddress
108230
typealias InvocationDecoder = FakeInvocationDecoder
@@ -174,10 +296,10 @@ struct Error_wrongReturn: DistributedActorSystem {
174296

175297
struct BadRemoteCall_param: DistributedActorSystem {
176298
// expected-error@-1{{struct 'BadRemoteCall_param' is missing witness for protocol requirement 'remoteCall'}}
177-
// expected-note@-2{{protocol 'BadRemoteCall_param' requires function 'remoteCall' with signature:}}
299+
// expected-note@-2{{protocol 'DistributedActorSystem' requires function 'remoteCall' with signature:}}
178300

179301
// expected-error@-4{{struct 'BadRemoteCall_param' is missing witness for protocol requirement 'remoteCallVoid'}}
180-
// expected-note@-5{{protocol 'BadRemoteCall_param' requires function 'remoteCallVoid' with signature:}}
302+
// expected-note@-5{{protocol 'DistributedActorSystem' requires function 'remoteCallVoid' with signature:}}
181303

182304
typealias ActorID = ActorAddress
183305
typealias InvocationDecoder = FakeInvocationDecoder
@@ -284,7 +406,7 @@ public struct BadRemoteCall_notPublic: DistributedActorSystem {
284406

285407
public struct BadRemoteCall_badResultConformance: DistributedActorSystem {
286408
// expected-error@-1{{struct 'BadRemoteCall_badResultConformance' is missing witness for protocol requirement 'remoteCall'}}
287-
// expected-note@-2{{protocol 'BadRemoteCall_badResultConformance' requires function 'remoteCall' with signature:}}
409+
// expected-note@-2{{protocol 'DistributedActorSystem' requires function 'remoteCall' with signature:}}
288410

289411
public typealias ActorID = ActorAddress
290412
public typealias InvocationDecoder = PublicFakeInvocationDecoder
@@ -391,7 +513,7 @@ struct BadRemoteCall_largeSerializationRequirement: DistributedActorSystem {
391513

392514
struct BadRemoteCall_largeSerializationRequirementSlightlyOffInDefinition: DistributedActorSystem {
393515
// expected-error@-1{{struct 'BadRemoteCall_largeSerializationRequirementSlightlyOffInDefinition' is missing witness for protocol requirement 'remoteCall'}}
394-
// expected-note@-2{{protocol 'BadRemoteCall_largeSerializationRequirementSlightlyOffInDefinition' requires function 'remoteCall' with signature:}}
516+
// expected-note@-2{{protocol 'DistributedActorSystem' requires function 'remoteCall' with signature:}}
395517

396518
typealias ActorID = ActorAddress
397519
typealias InvocationDecoder = LargeSerializationReqFakeInvocationDecoder
@@ -547,7 +669,7 @@ public struct PublicFakeInvocationEncoder: DistributedTargetInvocationEncoder {
547669

548670
struct FakeInvocationEncoder_missing_recordArgument: DistributedTargetInvocationEncoder {
549671
//expected-error@-1{{struct 'FakeInvocationEncoder_missing_recordArgument' is missing witness for protocol requirement 'recordArgument'}}
550-
//expected-note@-2{{protocol 'FakeInvocationEncoder_missing_recordArgument' requires function 'recordArgument' with signature:}}
672+
//expected-note@-2{{protocol 'DistributedTargetInvocationEncoder' requires function 'recordArgument' with signature:}}
551673
typealias SerializationRequirement = Codable
552674

553675
mutating func recordGenericSubstitution<T>(_ type: T.Type) throws {}
@@ -559,7 +681,7 @@ struct FakeInvocationEncoder_missing_recordArgument: DistributedTargetInvocation
559681

560682
struct FakeInvocationEncoder_missing_recordArgument2: DistributedTargetInvocationEncoder {
561683
//expected-error@-1{{struct 'FakeInvocationEncoder_missing_recordArgument2' is missing witness for protocol requirement 'recordArgument'}}
562-
//expected-note@-2{{protocol 'FakeInvocationEncoder_missing_recordArgument2' requires function 'recordArgument' with signature:}}
684+
//expected-note@-2{{protocol 'DistributedTargetInvocationEncoder' requires function 'recordArgument' with signature:}}
563685
typealias SerializationRequirement = Codable
564686

565687
mutating func recordGenericSubstitution<T>(_ type: T.Type) throws {}
@@ -571,7 +693,7 @@ struct FakeInvocationEncoder_missing_recordArgument2: DistributedTargetInvocatio
571693

572694
struct FakeInvocationEncoder_missing_recordReturnType: DistributedTargetInvocationEncoder {
573695
//expected-error@-1{{struct 'FakeInvocationEncoder_missing_recordReturnType' is missing witness for protocol requirement 'recordReturnType'}}
574-
//expected-note@-2{{protocol 'FakeInvocationEncoder_missing_recordReturnType' requires function 'recordReturnType' with signature:}}
696+
//expected-note@-2{{protocol 'DistributedTargetInvocationEncoder' requires function 'recordReturnType' with signature:}}
575697
typealias SerializationRequirement = Codable
576698

577699
mutating func recordGenericSubstitution<T>(_ type: T.Type) throws {}
@@ -594,7 +716,7 @@ struct FakeInvocationEncoder_missing_recordErrorType: DistributedTargetInvocatio
594716

595717
struct FakeInvocationEncoder_recordArgument_wrongType: DistributedTargetInvocationEncoder {
596718
//expected-error@-1{{struct 'FakeInvocationEncoder_recordArgument_wrongType' is missing witness for protocol requirement 'recordArgument'}}
597-
//expected-note@-2{{protocol 'FakeInvocationEncoder_recordArgument_wrongType' requires function 'recordArgument' with signature:}}
719+
//expected-note@-2{{protocol 'DistributedTargetInvocationEncoder' requires function 'recordArgument' with signature:}}
598720
typealias SerializationRequirement = Codable
599721

600722
mutating func recordGenericSubstitution<T>(_ type: T.Type) throws {}
@@ -607,7 +729,7 @@ struct FakeInvocationEncoder_recordArgument_wrongType: DistributedTargetInvocati
607729
}
608730
struct FakeInvocationEncoder_recordArgument_missingMutating: DistributedTargetInvocationEncoder {
609731
//expected-error@-1{{struct 'FakeInvocationEncoder_recordArgument_missingMutating' is missing witness for protocol requirement 'recordArgument'}}
610-
//expected-note@-2{{protocol 'FakeInvocationEncoder_recordArgument_missingMutating' requires function 'recordArgument' with signature:}}
732+
//expected-note@-2{{protocol 'DistributedTargetInvocationEncoder' requires function 'recordArgument' with signature:}}
611733
typealias SerializationRequirement = Codable
612734

613735
mutating func recordGenericSubstitution<T>(_ type: T.Type) throws {}
@@ -619,7 +741,7 @@ struct FakeInvocationEncoder_recordArgument_missingMutating: DistributedTargetIn
619741

620742
struct FakeInvocationEncoder_recordResultType_wrongType: DistributedTargetInvocationEncoder {
621743
//expected-error@-1{{struct 'FakeInvocationEncoder_recordResultType_wrongType' is missing witness for protocol requirement 'recordReturnType'}}
622-
//expected-note@-2{{protocol 'FakeInvocationEncoder_recordResultType_wrongType' requires function 'recordReturnType' with signature:}}
744+
//expected-note@-2{{protocol 'DistributedTargetInvocationEncoder' requires function 'recordReturnType' with signature:}}
623745
typealias SerializationRequirement = Codable
624746

625747
mutating func recordGenericSubstitution<T>(_ type: T.Type) throws {}
@@ -696,7 +818,7 @@ public final class PublicFakeInvocationDecoder_badNotPublic: DistributedTargetIn
696818

697819
final class PublicFakeInvocationDecoder_badBadProtoRequirement: DistributedTargetInvocationDecoder {
698820
// expected-error@-1{{class 'PublicFakeInvocationDecoder_badBadProtoRequirement' is missing witness for protocol requirement 'decodeNextArgument'}}
699-
// expected-note@-2{{protocol 'PublicFakeInvocationDecoder_badBadProtoRequirement' requires function 'decodeNextArgument' with signature:}}
821+
// expected-note@-2{{protocol 'DistributedTargetInvocationDecoder' requires function 'decodeNextArgument' with signature:}}
700822
typealias SerializationRequirement = Codable
701823

702824
func decodeGenericSubstitutions() throws -> [Any.Type] { [] }
@@ -748,7 +870,7 @@ struct LargeSerializationReqFakeInvocationResultHandler: DistributedTargetInvoca
748870

749871
struct BadResultHandler_missingOnReturn: DistributedTargetInvocationResultHandler {
750872
// expected-error@-1{{struct 'BadResultHandler_missingOnReturn' is missing witness for protocol requirement 'onReturn'}}
751-
// expected-note@-2{{protocol 'BadResultHandler_missingOnReturn' requires function 'onReturn' with signature:}}
873+
// expected-note@-2{{protocol 'DistributedTargetInvocationResultHandler' requires function 'onReturn' with signature:}}
752874
typealias SerializationRequirement = Codable
753875

754876
// func onReturn<Res: SerializationRequirement>(value: Res) async throws {} // MISSING
@@ -758,7 +880,7 @@ struct BadResultHandler_missingOnReturn: DistributedTargetInvocationResultHandle
758880

759881
struct BadResultHandler_missingRequirement: DistributedTargetInvocationResultHandler {
760882
// expected-error@-1{{struct 'BadResultHandler_missingRequirement' is missing witness for protocol requirement 'onReturn'}}
761-
// expected-note@-2{{protocol 'BadResultHandler_missingRequirement' requires function 'onReturn' with signature:}}
883+
// expected-note@-2{{protocol 'DistributedTargetInvocationResultHandler' requires function 'onReturn' with signature:}}
762884
typealias SerializationRequirement = Codable
763885

764886
func onReturn<Success>(value: Success) async throws {} // MISSING : Codable
@@ -767,8 +889,8 @@ struct BadResultHandler_missingRequirement: DistributedTargetInvocationResultHan
767889
}
768890

769891
struct BadResultHandler_mutatingButShouldNotBe: DistributedTargetInvocationResultHandler {
770-
// expected-error@-1{{struct 'BadResultHandler_missingRequirement' is missing witness for protocol requirement 'onReturn'}}
771-
// expected-note@-2{{protocol 'BadResultHandler_missingRequirement' requires function 'onReturn' with signature:}}
892+
// expected-error@-1{{struct 'BadResultHandler_mutatingButShouldNotBe' is missing witness for protocol requirement 'onReturn'}}
893+
// expected-note@-2{{protocol 'DistributedTargetInvocationResultHandler' requires function 'onReturn' with signature:}}
772894
typealias SerializationRequirement = Codable
773895

774896
mutating func onReturn<Success: Codable>(value: Success) async throws {} // WRONG: can't be mutating

0 commit comments

Comments
 (0)