-
Notifications
You must be signed in to change notification settings - Fork 87
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Scorekeeper Refactoring 1/4 #2934
Open
vovacha
wants to merge
3
commits into
w3f:staging
Choose a base branch
from
vovacha:refactor/scorekeeper-1
base: staging
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
import { startJob } from "./cron/StartCronJobs"; | ||
import logger from "../../logger"; | ||
import { jobStatusEmitter } from "../../Events"; | ||
import { JobStatus, JobConfig, JobRunnerMetadata } from "./types"; | ||
|
||
export class Job { | ||
protected status: JobStatus; | ||
protected jobConfig: JobConfig; | ||
protected jobRunnerMetadata: JobRunnerMetadata; | ||
|
||
// TODO: remove this dependency injection | ||
private startJobFunction: ( | ||
metadata: JobRunnerMetadata, | ||
jobConfig: JobConfig, | ||
) => Promise<void>; | ||
|
||
// TODO: remove events and use db to handle the state | ||
// then we can decouple scorekeeper and gateway | ||
static events: string[] = [ | ||
"jobStarted", | ||
"jobRunning", | ||
"jobFinished", | ||
"jobErrored", | ||
"jobProgress", | ||
]; | ||
|
||
constructor(jobConfig: JobConfig, jobRunnerMetadata: JobRunnerMetadata) { | ||
this.status = { | ||
name: jobConfig.name, | ||
updated: Date.now(), | ||
status: "Not Running", | ||
}; | ||
this.jobConfig = jobConfig; | ||
this.jobRunnerMetadata = jobRunnerMetadata; | ||
this.startJobFunction = startJob; | ||
} | ||
|
||
private log(message: string) { | ||
logger.info(message, { label: "Job" }); | ||
} | ||
|
||
// TODO: remove events and use db to handle the state | ||
// then we can decouple scorekeeper and gateway | ||
private registerEventHandlers() { | ||
this.log(`Registering event handlers for ${this.jobConfig.name}`); | ||
Job.events.forEach((event) => { | ||
jobStatusEmitter.on(event, (data: JobStatus) => { | ||
this.updateJobStatus(data); | ||
}); | ||
}); | ||
} | ||
|
||
public async run(): Promise<void> { | ||
this.registerEventHandlers(); | ||
this.log(`Starting ${this.getName()}`); | ||
await this.startJobFunction(this.jobRunnerMetadata, this.jobConfig); | ||
} | ||
|
||
// TODO: remove this public interface after decoupling with the Gateway | ||
public getName(): string { | ||
return this.jobConfig.name; | ||
} | ||
|
||
public updateJobStatus(status: JobStatus) { | ||
if (status.name == this.getName()) { | ||
this.status = { ...this.status, ...status }; | ||
} | ||
} | ||
|
||
public getStatusAsJson(): string { | ||
return JSON.stringify(this.status); | ||
} | ||
|
||
public getStatus(): JobStatus { | ||
return this.status; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should be of type StatusName, right ? can we avoid to have the string
Not Running
hardcoded ?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I partially answered in the previous comment. Please let me know if you want me to include this in the current PR.
For the renaming issue, there is a dependency at least on
scorekeeper-status-ui
.For the hardcoding issue, it's easier, but the plan was to tackle it together.