swift-server/swift-service-lifecycle

Provide a `CancelOnGracefulShutdownService`

Open

#163 opened on Oct 31, 2023

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Swift (48 forks)auto 404
good first issue

Repository metrics

Stars
 (528 stars)
PR merge metrics
 (PR metrics pending)

Description

If an adopter already has a reference type that implements a run() method it is currently impossible to support ServiceLifecycle, even though the implementation works easily:

extension MyExistingService: Service {}

The reason for this is, that ServiceLifecycle uses gracefulShutdown to signal shutdown instead of Task cancellation. That is the correct call. However it is impossible to add gracefulShutdown support to object that already expose a run() method. That's why im proposing that ServiceLifecycle offers a CancelOnGracefulShutdownService<Underlying: Service>.

Contributor guide

Research direction
Explore the existing Service protocol and graceful shutdown mechanism in ServiceLifecycle. Study how other wrapper types like ServiceGroup are implemented. Implement a generic CancelOnGracefulShutdownService that wraps an existing service and translates graceful shutdown into a cancellation signal.
Tech stack
swift
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SwiftSwift concurrency
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70