mineralscloud / easyjobsbase.jl Goto Github PK

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!

Description

This is a feature request for introducing a new Julia type called JobRunner (or a similar name) in the EasyJobsBase.jl package. The primary purpose of this type is to monitor and manage the job running status.

Motivation

Currently, we cannot save the scheduled task (Task type) to the Job type because it cannot be serialized by serializers like JLD2.jl. As a result, it has been deprecated in PR MineralsCloud/SimpleWorkflows.jl#137. Instead of storing the scheduled task in the Job type, it's proposed to create a new JobRunner type that will track the scheduled task in its ref field.
Returning a JobRunner-like thing was the very original design when I wrote SimpleWorkflows.jl. But back in the day, we have a problem with whether to return a Job or a JobRunner since we used run instead of run!. But now this is not a problem since we will use run! in the future.

Benefits

1. This new JobRunner type will not cause breaking changes, as the run! function for Job types modifies the objects directly. So, whether it returns a Job type or a JobRunner type doesn't matter.

2. It will make it easier to stop jobs. Previously, we saved them in a global constant called JOB_REGISTRY. With the new JobRunner type, we can manage to stop jobs more efficiently.

Implementation

The JobRunner type could be implemented as follows:

struct JobRunner
    job::Job
    ref::Task
end