NOISSUE : Enhance Event Status #235

WashingtonKK · 2024-09-09T18:15:59Z

What type of PR is this?

This is an enhancement that improves the status of events sent from agent and manager.

What does this do?

This enhances the events sent from agent and manager to make them more user friendly.

Which issue(s) does this PR fix/relate to?

Resolves https://github.com/ultravioletrs/prism/issues/441

Have you included tests for your changes?

Not needed.

Did you document any new/modified feature?

No

Notes

To be merged along with: https://github.com/ultravioletrs/prism/pull/478

smithjilks · 2024-09-10T12:20:02Z

agent/service.go

-	svc.sm.StateFunctions[resultsReady] = svc.publishEvent("in-progress", json.RawMessage{})
-	svc.sm.StateFunctions[complete] = svc.publishEvent("in-progress", json.RawMessage{})
+	svc.sm.StateFunctions[results] = svc.publishEvent("ready", json.RawMessage{})
+	svc.sm.StateFunctions[complete] = svc.publishEvent("complete", json.RawMessage{})


You can use constants here and any other appropriate place.

SammyOina · 2024-09-10T17:26:44Z

agent/state.go

 	receivingData
 	running
-	resultsReady
+	results


It's results so that the full event with status would be: results ready. Rather than resultsReady ready

state results is not really self explanatory here, a better term is required

SammyOina · 2024-09-11T09:11:38Z

agent/service.go

+	svc.sm.StateFunctions[idle] = svc.publishEvent("idle", json.RawMessage{})
+	svc.sm.StateFunctions[receivingManifest] = svc.publishEvent(progress, json.RawMessage{})
+	svc.sm.StateFunctions[receivingAlgorithm] = svc.publishEvent(progress, json.RawMessage{})
+	svc.sm.StateFunctions[receivingData] = svc.publishEvent(progress, json.RawMessage{})
+	svc.sm.StateFunctions[results] = svc.publishEvent("ready", json.RawMessage{})
+	svc.sm.StateFunctions[complete] = svc.publishEvent("complete", json.RawMessage{})
 	svc.sm.StateFunctions[running] = svc.runComputation
 	svc.sm.StateFunctions[failed] = svc.publishEvent("failed", json.RawMessage{})


make status a typed constant for consistency

SammyOina · 2024-09-12T16:25:35Z

agent/state.go

+	ReceivingAlgorithm
+	ReceivingData
+	Running
+	ResultFetch


ConsumingResults is better here, with status started, in progress and complete

SammyOina · 2024-09-12T16:26:37Z

agent/state.go

+type Status uint8
+
+const (
+	IdleState Status = iota
+	InProgress
+	Ready
+	Completed
+	Terminated


manager also has status and will have a general pattern, started, in progress, complete and failed

I am using these statuses for manager.

SammyOina · 2024-09-12T16:27:37Z

manager/service.go

events are also published from manager on other files like agent events, and vm package as well as logging

see also agent logging and algorithm package

All events use the states and statuses in manger, except for this one:

https://github.com/ultravioletrs/cocos/blob/main/agent/algorithm/logging.go#L68-L70

Since it is unique.

define all of them in a list including that one

SammyOina · 2024-09-12T16:29:05Z

manager/service.go

 	ms.qemuCfg.VSockConfig.Vnc++

-	ms.publishEvent("vm-provision", c.Id, "complete", json.RawMessage{})
+	ms.publishEvent("vm-provision", c.Id, agent.Completed.String(), json.RawMessage{})


also set a typed constant for manager states, i.e vm-provision, vm-running, ...

We only have two states for manager states, vm provision and stop computation

there are additional states, see vm package and qemu package

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina · 2024-09-16T07:13:59Z

manager/manager_states.go

+const (
+	VmProvision ManagerState = iota
+	StopComputation
+	Starting


state and status are different

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina · 2024-09-16T10:55:49Z

agent/algorithm/logging.go

 	}

-	if err := s.EventSvc.SendEvent("algorithm-run", "error", json.RawMessage{}); err != nil {
+	if err := s.EventSvc.SendEvent(manager.AlgorithmRun.String(), manager.Error.String(), json.RawMessage{}); err != nil {


algo run should be in agent

If we move this to agent package, importing it here will result in an import cycle hence that will return us to using a string literal.

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina · 2024-09-17T08:40:48Z

agent/algorithm/logging.go

 	}

-	if err := s.EventSvc.SendEvent("algorithm-run", "error", json.RawMessage{}); err != nil {
+	if err := s.EventSvc.SendEvent("AlgorithmRun", manager.Error.String(), json.RawMessage{}); err != nil {


should be a constant, also avoid imports from manager on agent

That is pkg/manager and not manager package. Also, what do you mean by should be a string?

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

WashingtonKK changed the title ~~enhance timeline~~ NOISSUE : Enhance Event Status Sep 9, 2024

smithjilks reviewed Sep 10, 2024

View reviewed changes

WashingtonKK requested a review from smithjilks September 10, 2024 13:33

SammyOina requested changes Sep 10, 2024

View reviewed changes

SammyOina requested changes Sep 11, 2024

View reviewed changes

WashingtonKK force-pushed the prism-441 branch from 17b9d30 to 148d1f8 Compare September 12, 2024 14:49

SammyOina requested changes Sep 12, 2024

View reviewed changes

WashingtonKK added 9 commits September 13, 2024 18:16

enhance timeline

1c785b9

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

fix: remove redundant event

70b864c

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

use constant

406bff4

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

lint

fc0bac0

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

use typed constant for status

8a1358e

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

refactor status

860fd79

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

export agent status and state

b555e72

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

ehance event states

9fbab60

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

fix tests

b23f9c7

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

WashingtonKK force-pushed the prism-441 branch from 865f906 to b23f9c7 Compare September 13, 2024 15:17

SammyOina requested changes Sep 16, 2024

View reviewed changes

use manager states and status

ded38ec

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina requested changes Sep 16, 2024

View reviewed changes

move algo-run to agent package

90ba426

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina requested changes Sep 17, 2024

View reviewed changes

WashingtonKK added 2 commits September 17, 2024 16:30

replace literal with constant

4eda40f

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

replace manager variable with constant

1c9b299

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina approved these changes Sep 17, 2024

View reviewed changes

SammyOina assigned WashingtonKK Sep 17, 2024

dborovcanin approved these changes Sep 17, 2024

View reviewed changes

dborovcanin merged commit c14a633 into ultravioletrs:main Sep 17, 2024
1 check passed

WashingtonKK deleted the prism-441 branch September 17, 2024 13:58

NOISSUE : Enhance Event Status #235

NOISSUE : Enhance Event Status #235

Uh oh!

Conversation

WashingtonKK commented Sep 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

What does this do?

Which issue(s) does this PR fix/relate to?

Have you included tests for your changes?

Did you document any new/modified feature?

Notes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WashingtonKK Sep 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SammyOina Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

WashingtonKK commented Sep 9, 2024 •

edited

Loading

WashingtonKK Sep 13, 2024 •

edited

Loading

SammyOina Sep 17, 2024 •

edited

Loading