-
Notifications
You must be signed in to change notification settings - Fork 109
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
motivation: make it simpler to register shutdown hooks changes: * introduce Terminator helper that allow registering and de-registaring shutdown handlers * expose the new terminator hanler on the InitializationContext and deprecate ShutdownContext * deprecate the Handler::shutdown protocol requirment * update the runtime code to use the new terminator instead of calling shutdown on the handler * add and adjust tests
- Loading branch information
Showing
9 changed files
with
201 additions
and
63 deletions.
There are no files selected for viewing
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
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
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
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
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,139 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the SwiftAWSLambdaRuntime open source project | ||
| // | ||
| // Copyright (c) 2022 Apple Inc. and the SwiftAWSLambdaRuntime project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import NIOConcurrencyHelpers | ||
| import NIOCore | ||
|
|
||
| /// Lambda terminator. | ||
| /// Utility to manage the lambda shutdown sequence. | ||
| public final class LambdaTerminator { | ||
| private typealias Handler = (EventLoop) -> EventLoopFuture<Void> | ||
|
|
||
| private var storage: Storage | ||
|
|
||
| init() { | ||
| self.storage = Storage() | ||
| } | ||
|
|
||
| /// Register a shutdown handler with the terminator | ||
| /// | ||
| /// - parameters: | ||
| /// - name: Display name for logging purposes | ||
| /// - handler: The shutdown handler to call when terminating the Lambda. | ||
| /// Shutdown handlers are called in the reverse order of being registered. | ||
| /// | ||
| /// - Returns: A `RegistrationKey` that can be used to de-register the handler when its no longer needed. | ||
| @discardableResult | ||
| public func register(name: String, handler: @escaping (EventLoop) -> EventLoopFuture<Void>) -> RegistrationKey { | ||
| let key = RegistrationKey() | ||
| self.storage.add(key: key, name: name, handler: handler) | ||
| return key | ||
| } | ||
|
|
||
| /// De-register a shutdown handler with the terminator | ||
| /// | ||
| /// - parameters: | ||
| /// - key: A `RegistrationKey` obtained from calling the register API. | ||
| public func deregister(_ key: RegistrationKey) { | ||
| self.storage.remove(key) | ||
| } | ||
|
|
||
| /// Begin the termination cycle | ||
| /// Shutdown handlers are called in the reverse order of being registered. | ||
| /// | ||
| /// - parameters: | ||
| /// - eventLoop: The `EventLoop` to run the termination on. | ||
| /// | ||
| /// - Returns: An `EventLoopFuture` with the result of the termination cycle. | ||
| internal func terminate(eventLoop: EventLoop) -> EventLoopFuture<Void> { | ||
| func terminate(_ iterator: IndexingIterator<[(name: String, handler: Handler)]>, errors: [Error], promise: EventLoopPromise<Void>) { | ||
| var iterator = iterator | ||
| guard let handler = iterator.next()?.handler else { | ||
| if errors.isEmpty { | ||
| return promise.succeed(()) | ||
| } else { | ||
| return promise.fail(TerminationError(underlying: errors)) | ||
| } | ||
| } | ||
| handler(eventLoop).whenComplete { result in | ||
| var errors = errors | ||
| if case .failure(let error) = result { | ||
| errors.append(error) | ||
| } | ||
| return terminate(iterator, errors: errors, promise: promise) | ||
| } | ||
| } | ||
|
|
||
| // terminate in cascading, reverse order | ||
| let promise = eventLoop.makePromise(of: Void.self) | ||
| terminate(self.storage.handlers.reversed().makeIterator(), errors: [], promise: promise) | ||
| return promise.futureResult | ||
| } | ||
| } | ||
|
|
||
| extension LambdaTerminator { | ||
| /// Lambda terminator registration key. | ||
| public struct RegistrationKey: Hashable, CustomStringConvertible { | ||
| var value: String | ||
|
|
||
| init() { | ||
| // UUID basically | ||
| self.value = LambdaRequestID().uuidString | ||
| } | ||
|
|
||
| public var description: String { | ||
| self.value | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension LambdaTerminator { | ||
| private final class Storage { | ||
| private let lock: Lock | ||
| private var index: [RegistrationKey] | ||
| private var map: [RegistrationKey: (name: String, handler: Handler)] | ||
|
|
||
| init() { | ||
| self.lock = .init() | ||
| self.index = [] | ||
| self.map = [:] | ||
| } | ||
|
|
||
| func add(key: RegistrationKey, name: String, handler: @escaping Handler) { | ||
| self.lock.withLock { | ||
| self.index.append(key) | ||
| self.map[key] = (name: name, handler: handler) | ||
| } | ||
| } | ||
|
|
||
| func remove(_ key: RegistrationKey) { | ||
| self.lock.withLock { | ||
| self.index = self.index.filter { $0 != key } | ||
| self.map[key] = nil | ||
| } | ||
| } | ||
|
|
||
| var handlers: [(name: String, handler: Handler)] { | ||
| self.lock.withLock { | ||
| self.index.compactMap { self.map[$0] } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension LambdaTerminator { | ||
| struct TerminationError: Error { | ||
| let underlying: [Error] | ||
| } | ||
| } |
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
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
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
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