-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bring HealthService API in line with ReflectionService (#24)
Motivation: The reflection service is a single type called `ReflectionService`. The Health service is a single type (called `Health`) holding an instance of the `HealthService` and a type to provide values to the service. This indirection isn't necessary, the health service can just hold it instead. This makes the API more like the reflection service and removes indirection. Modifications: - Remove indirection from health service and rename from 'Health' to 'HealthService'. - Make the reflection service a struct (it was a class for no good reason). Result: More consistent API
- Loading branch information
Showing
5 changed files
with
222 additions
and
228 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
/* | ||
* Copyright 2024, gRPC Authors All rights reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
internal import GRPCCore | ||
private import Synchronization | ||
|
||
extension HealthService { | ||
internal struct Service: Grpc_Health_V1_Health.ServiceProtocol { | ||
private let state = Self.State() | ||
} | ||
} | ||
|
||
extension HealthService.Service { | ||
func check( | ||
request: ServerRequest<Grpc_Health_V1_HealthCheckRequest>, | ||
context: ServerContext | ||
) async throws -> ServerResponse<Grpc_Health_V1_HealthCheckResponse> { | ||
let service = request.message.service | ||
|
||
guard let status = self.state.currentStatus(ofService: service) else { | ||
throw RPCError(code: .notFound, message: "Requested service unknown.") | ||
} | ||
|
||
var response = Grpc_Health_V1_HealthCheckResponse() | ||
response.status = status | ||
|
||
return ServerResponse(message: response) | ||
} | ||
|
||
func watch( | ||
request: ServerRequest<Grpc_Health_V1_HealthCheckRequest>, | ||
context: ServerContext | ||
) async -> StreamingServerResponse<Grpc_Health_V1_HealthCheckResponse> { | ||
let service = request.message.service | ||
let statuses = AsyncStream.makeStream(of: Grpc_Health_V1_HealthCheckResponse.ServingStatus.self) | ||
|
||
self.state.addContinuation(statuses.continuation, forService: service) | ||
|
||
return StreamingServerResponse(of: Grpc_Health_V1_HealthCheckResponse.self) { writer in | ||
var response = Grpc_Health_V1_HealthCheckResponse() | ||
|
||
for await status in statuses.stream { | ||
response.status = status | ||
try await writer.write(response) | ||
} | ||
|
||
return [:] | ||
} | ||
} | ||
|
||
func updateStatus( | ||
_ status: Grpc_Health_V1_HealthCheckResponse.ServingStatus, | ||
forService service: String | ||
) { | ||
self.state.updateStatus(status, forService: service) | ||
} | ||
} | ||
|
||
extension HealthService.Service { | ||
private final class State: Sendable { | ||
// The state of each service keyed by the fully qualified service name. | ||
private let lockedStorage = Mutex([String: ServiceState]()) | ||
|
||
fileprivate func currentStatus( | ||
ofService service: String | ||
) -> Grpc_Health_V1_HealthCheckResponse.ServingStatus? { | ||
return self.lockedStorage.withLock { $0[service]?.currentStatus } | ||
} | ||
|
||
fileprivate func updateStatus( | ||
_ status: Grpc_Health_V1_HealthCheckResponse.ServingStatus, | ||
forService service: String | ||
) { | ||
self.lockedStorage.withLock { storage in | ||
storage[service, default: ServiceState(status: status)].updateStatus(status) | ||
} | ||
} | ||
|
||
fileprivate func addContinuation( | ||
_ continuation: AsyncStream<Grpc_Health_V1_HealthCheckResponse.ServingStatus>.Continuation, | ||
forService service: String | ||
) { | ||
self.lockedStorage.withLock { storage in | ||
storage[service, default: ServiceState(status: .serviceUnknown)] | ||
.addContinuation(continuation) | ||
} | ||
} | ||
} | ||
|
||
// Encapsulates the current status of a service and the continuations of its watch streams. | ||
private struct ServiceState: Sendable { | ||
private(set) var currentStatus: Grpc_Health_V1_HealthCheckResponse.ServingStatus | ||
private var continuations: | ||
[AsyncStream<Grpc_Health_V1_HealthCheckResponse.ServingStatus>.Continuation] | ||
|
||
fileprivate mutating func updateStatus( | ||
_ status: Grpc_Health_V1_HealthCheckResponse.ServingStatus | ||
) { | ||
guard status != self.currentStatus else { | ||
return | ||
} | ||
|
||
self.currentStatus = status | ||
|
||
for continuation in self.continuations { | ||
continuation.yield(status) | ||
} | ||
} | ||
|
||
fileprivate mutating func addContinuation( | ||
_ continuation: AsyncStream<Grpc_Health_V1_HealthCheckResponse.ServingStatus>.Continuation | ||
) { | ||
self.continuations.append(continuation) | ||
continuation.yield(self.currentStatus) | ||
} | ||
|
||
fileprivate init(status: Grpc_Health_V1_HealthCheckResponse.ServingStatus = .unknown) { | ||
self.currentStatus = status | ||
self.continuations = [] | ||
} | ||
} | ||
} |
Oops, something went wrong.