Skip to content
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.

Sign up for GitHub

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

Zinnia started -> {Spark,Voyager} started #327

Merged
merged 1 commit into from
Feb 1, 2024
Merged

Zinnia started -> {Spark,Voyager} started #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,5 +92,8 @@ jobs:
sleep 10 # Wait for Station modules to start
docker logs station

- name: Check | Zinnia started
run: docker logs station | grep "Zinnia started"
- name: Check | Spark started
run: docker logs station | grep "Spark started"

- name: Check | Voyager started
run: docker logs station | grep "Voyager started"
6 changes: 4 additions & 2 deletions lib/zinnia.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,15 +260,17 @@ async function handleEvents ({
case 'activity:info':
onActivity({
type: 'info',
message: event.message.replace(/Module Runtime/, 'Zinnia'),
message:
event.message.replace(/Module Runtime/, capitalize(module)),
source: event.module
})
break

case 'activity:error':
onActivity({
type: 'error',
message: event.message.replace(/Module Runtime/, 'Zinnia'),
message:
event.message.replace(/Module Runtime/, capitalize(module)),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, these checks will break after we integrate filecoin-station/zinnia#470

It makes me wonder whether we should make a bigger change in the current design:

  • push these "{module} started" messages from Zinnia/Core to individual modules
  • remove the generic "Zinnia started" message completely

WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another option: Instead of working with strings, objectify these events into new type:

{ type: activity:start }

That should be enough for this case

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a great idea to use a new event type 👍🏻

Do you think it should be Zinnia or the module that reports this new event?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. For consistency it would be better if Zinnia emits it. Otoh it's less semantic, as it only means "I have finished my process startup". If the module does it, it can potentially delay until it has finished all its necessary initialization.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future, I'd like one zinniad process to run multiple modules. In that future, I can imagine having both events: "module runtime started" and "Spark started"/"Voyager started".

For now, I think the simplest option is to add this event to zinniad, because then we don't have to expose a new activity API to the JavaScript side.

It may be enough to make print_event() function public
https://github.com/filecoin-station/zinnia/blob/d0d12693f565574e2d286b79eb397a6f8f104e3a/daemon/station_reporter.rs#L65-L72

Then change this line to call print_event() instead of log_info_activity()
https://github.com/filecoin-station/zinnia/blob/d0d12693f565574e2d286b79eb397a6f8f104e3a/daemon/main.rs#L59

IIRC, we have two kinds of events - one for the runtime, another for the module(s). Events reported by the runtime come with module: null. I would use this mechanism for the start event printed by the runtime.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See filecoin-station/zinnia#475

source: event.module
})
break
Expand Down
9 changes: 6 additions & 3 deletions test/station.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ describe('Station', () => {
const ps = startStation()
await Promise.all([
streamMatch(ps.stdout, 'totalJobsCompleted'),
streamMatch(ps.stdout, 'Zinnia started')
streamMatch(ps.stdout, 'Spark started'),
streamMatch(ps.stdout, 'Voyager started')
])
stopStation()
})
Expand All @@ -28,7 +29,8 @@ describe('Station', () => {
const ps = startStation()
await Promise.all([
streamMatch(ps.stdout, 'totalJobsCompleted'),
streamMatch(ps.stdout, 'Zinnia started')
streamMatch(ps.stdout, 'Spark started'),
streamMatch(ps.stdout, 'Voyager started')
])
stopStation()
})
Expand All @@ -37,7 +39,8 @@ describe('Station', () => {

await Promise.all([
streamMatch(ps.stdout, 'jobs-completed'),
streamMatch(ps.stdout, /activity:info.*(Zinnia started)/)
streamMatch(ps.stdout, /activity:info.*(Spark started)/),
streamMatch(ps.stdout, /activity:info.*(Voyager started)/)
])

stopStation()
Expand Down