WIP: Add JobManager
#4287
WIP: Add JobManager
#4287
Conversation
BalmungSan
force-pushed
the
add-job-manager
branch
from
21ea992 to
1e7138f
Compare
| * Creates and launches the given `Job` in the background. If another Job with the same id was | ||
| * already running, it will be cancelled before starting this one. | ||
| */ | ||
| def startJob(id: Id, job: Resource[F, JobManager.Job[F, S]]): F[Unit] |
There was a problem hiding this comment.
On one had, I like the idea of users being able to use their own Ids.
On the other, I think most users would benefit from a default using automatically generated UUIDs.
Should we provide such default in some way?
| /** | ||
| * Gets the status of the `Job` associated with the given `id`. If `id` doesn't exists or the | ||
| * `Job` already finished then the returned value will be a `None`. | ||
| */ | ||
| def getJobStatus(id: Id): F[Option[S]] |
There was a problem hiding this comment.
I somewhat dislike the idea that both bad id and already finished return in a None.
But, otherwise, the map will grow indefinitely.
Any ideas?
| /** | ||
| * Signals cancellation of the `Job` associated with the given `id`, and waits for its | ||
| * completion. | ||
| */ | ||
| def cancelJob(id: Id): F[Unit] |
There was a problem hiding this comment.
Should we provide a cacelAndForget variant where we don't wait on cancellation?
| trait Job[F[_], S] { | ||
|
|
||
| /** | ||
| * Starts the logic of this `Job`. | ||
| */ | ||
| def run: F[Unit] | ||
|
|
||
| /** | ||
| * Gets the status of this `Job`. | ||
| */ | ||
| def getStatus: F[S] | ||
| } |
There was a problem hiding this comment.
Users would then implement this trait for their own Jobs.
| } | ||
| } | ||
|
|
||
| supervisor.supervise(runJob).void |
There was a problem hiding this comment.
We don't wait for the Job to start before returning to the user.
But, that means there is a brief delay between starting the Job and users being able to query its status.
| cancel = fiber.cancel | ||
| ).some | ||
| ) | ||
| .flatMap(_.traverse_(_.cancel)) >> |
There was a problem hiding this comment.
In case the same id was already used, we cancel the previous Job.
Implements the
JobManageridea proposed in #1345Roadmap