[core] add public "bookkept" flag to enable bookkeeping of an environ…

…ment
AliceO2Group · Sep 18, 2024 · 38127e5 · 38127e5
1 parent db5dbde
commit 38127e5
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 18 deletions.
diff --git a/common/protos/common.pb.go b/common/protos/common.pb.go
diff --git a/common/protos/common.proto b/common/protos/common.proto
@@ -45,4 +45,5 @@ message WorkflowTemplateInfo {
   string description = 2;
   string path = 3;
   bool public = 4; // whether the environment is public or not
+  bool bookkept = 5; // whether the runs should be logged in bookkeeping
 }
diff --git a/common/protos/events.pb.go b/common/protos/events.pb.go
diff --git a/core/environment/environment.go b/core/environment/environment.go
@@ -85,6 +85,7 @@ type Environment struct {
 	Public         bool   // From workflow or user
 	Description    string // From workflow
 	WorkflowPath   string // From workflow load
+	Bookkept       bool   // From workflow or user
 
 	callsPendingAwait map[string] /*await expression, trigger only*/ callable.CallsMap
 	currentTransition string
@@ -1409,6 +1410,7 @@ func (env *Environment) GetWorkflowInfo() *pb.WorkflowTemplateInfo {
 		Description: env.Description,
 		Path:        env.WorkflowPath,
 		Public:      env.Public,
+		Bookkept:    env.Bookkept,
 	}
 	return out
 }

diff --git a/core/environment/manager.go b/core/environment/manager.go
@@ -253,6 +253,7 @@ func (envs *Manager) CreateEnvironment(workflowPath string, userVars map[string]
 			Public:      workflowPublicInfo.IsPublic,
 			Name:        workflowPublicInfo.Name,
 			Description: workflowPublicInfo.Description,
+			Bookkept:    workflowPublicInfo.IsBookkept,
 		},
 	})
 
@@ -332,6 +333,7 @@ func (envs *Manager) CreateEnvironment(workflowPath string, userVars map[string]
 	env.name = workflowPublicInfo.Name
 	env.Description = workflowPublicInfo.Description
 	env.WorkflowPath = workflowPath
+	env.Bookkept = workflowPublicInfo.IsBookkept
 
 	the.EventWriterWithTopic(topic.Environment).WriteEvent(&evpb.Ev_EnvironmentEvent{
 		EnvironmentId:        newId.String(),
@@ -1210,6 +1212,7 @@ func (envs *Manager) CreateAutoEnvironment(workflowPath string, userVars map[str
 			Public:      workflowPublicInfo.IsPublic,
 			Name:        workflowPublicInfo.Name,
 			Description: workflowPublicInfo.Description,
+			Bookkept:    workflowPublicInfo.IsBookkept,
 		},
 	})
 
@@ -1232,6 +1235,7 @@ func (envs *Manager) CreateAutoEnvironment(workflowPath string, userVars map[str
 	env.name = workflowPublicInfo.Name
 	env.Description = workflowPublicInfo.Description
 	env.WorkflowPath = workflowPath
+	env.Bookkept = workflowPublicInfo.IsBookkept
 
 	the.EventWriterWithTopic(topic.Environment).WriteEvent(&evpb.Ev_EnvironmentEvent{
 		EnvironmentId:        newId.String(),

diff --git a/core/environment/utils.go b/core/environment/utils.go
@@ -39,6 +39,7 @@ type WorkflowPublicInfo struct {
 	IsPublic    bool
 	Name        string
 	Description string
+	IsBookkept  bool
 }
 
 func parseWorkflowPublicInfo(workflowExpr string) (WorkflowPublicInfo, error) {
@@ -67,8 +68,12 @@ func parseWorkflowPublicInfo(workflowExpr string) (WorkflowPublicInfo, error) {
 	if nodes["description"].Tag == "!public" {
 		description = nodes["description"].Value
 	}
+	bookkept := false
+	if nodes["bookkept"].Tag == "!public" {
+		bookkept = nodes["bookkept"].Value == "true"
+	}
 
-	return WorkflowPublicInfo{IsPublic: isPublic, Name: name, Description: description}, nil
+	return WorkflowPublicInfo{IsPublic: isPublic, Name: name, Description: description, IsBookkept: bookkept}, nil
 }
 
 func JSONSliceToSlice(payload string) (slice []string, err error) {