Actions Board View Rule

actions/actions.go

@@ -1,35 +1,5 @@
 package actions
 
-/*
-	 The actions system is a key component for process automation in WIT. It provides
-	 a way of executing user-configurable, dynamic process steps depending on user
-	 settings, schema settings and events in the WIT.
-
-	 The idea here is to provide a simple, yet powerful "publish-subscribe" system that
-	 can connect any "event" in the system to any "action" with a clear decoupling
-	 of events and actions with the goal of making the associations later dynamic and
-	 configurable by the user ("user connects this event to this action"). Think
-	 of a "IFTTT for WIT" (https://en.wikipedia.org/wiki/IFTTT).
-
-	 Actions are generic and atomic execution steps that do exactly one task and
-	 are configurable. The actions system around the actions provide a key-based
-	 execution of the actions.
-
-	 Some examples for an application of this system would be:
-		- closing all children of a parent WI that is being closed (the user connects the
-		"close" attribute change event of a WI to an action that closes all WIs of
-		a matching query).
-		- sending out notifications for mentions on markdown (the system executes an
-		action "send notification" for every mention found in markdown values).
-		- moving all WIs from one iteration to the next in the time sequence when
-		the original iteration is closed.
-
-		For all these automations, the actions system provides a re-usable, flexible
-		and later user configurable way of doing that without creating lots of
-		custom code and/or custom process implementations that are hardcoded in the
-		WIT.
-*/
-
 import (
 	"context"
 
@@ -65,21 +35,19 @@ func ExecuteActionsByChangeset(ctx context.Context, db application.DB, userID uu
 		actionConfig := actionConfigs[actionKey]
 		switch actionKey {
 		case rules.ActionKeyNil:
-			newContext, actionChanges, err = executeAction(rules.ActionNil{}, actionConfig, newContext, contextChanges, &actionChanges)
+			newContext, actionChanges, err = executeAction(rules.ActionNil{}, actionConfig, newContext, contextChanges, actionChanges)
 		case rules.ActionKeyFieldSet:
 			newContext, actionChanges, err = executeAction(rules.ActionFieldSet{
 				Db:     db,
 				Ctx:    ctx,
 				UserID: &userID,
-			}, actionConfig, newContext, contextChanges, &actionChanges)
-		/* commented out for now until this rule is added
+			}, actionConfig, newContext, contextChanges, actionChanges)
 		case rules.ActionKeyStateToMetastate:
 			newContext, actionChanges, err = executeAction(rules.ActionStateToMetaState{
 				Db:     db,
 				Ctx:    ctx,
 				UserID: &userID,
-			}, actionConfig, newContext, contextChanges, &actionChanges)
-		*/
+			}, actionConfig, newContext, contextChanges, actionChanges)
 		default:
 			return nil, nil, errs.New("action key " + actionKey + " is unknown")
 		}
@@ -93,7 +61,7 @@ func ExecuteActionsByChangeset(ctx context.Context, db application.DB, userID uu
 // executeAction executes the action given. The actionChanges contain the changes made by
 // prior action executions. The execution is expected to add/update their changes on this
 // change set.
-func executeAction(act rules.Action, configuration string, newContext change.Detector, contextChanges change.Set, actionChanges *change.Set) (change.Detector, change.Set, error) {
+func executeAction(act rules.Action, configuration string, newContext change.Detector, contextChanges change.Set, actionChanges change.Set) (change.Detector, change.Set, error) {
 	if act == nil {
 		return nil, nil, errs.New("rule can not be nil")
 	}

actions/doc.go

@@ -3,7 +3,7 @@ Package actions system is a key component for process automation in WIT. It prov
 way of executing user-configurable, dynamic process steps depending on user
 settings, schema settings and events in the WIT.
 
-The idea here is to provide a simple, yet powerful "signal-slot" system that
+The idea here is to provide a simple, yet powerful "publish-subscribe" system that
 can connect any "event" in the system to any "action" with a clear decoupling of
 events and actions with the goal of making the associations later dynamic and
 configurable by the user ("user connects this event to this action"). Think

actions/rules/action.go

@@ -24,5 +24,5 @@ type Action interface {
 	// updated attributes. It returns the new context. Note that this
 	// needs the new (after change) context and the old value(s) as
 	// part of the changeset.
-	OnChange(newContext change.Detector, contextChanges change.Set, configuration string, actionChanges *change.Set) (change.Detector, change.Set, error)
+	OnChange(newContext change.Detector, contextChanges change.Set, configuration string, actionChanges change.Set) (change.Detector, change.Set, error)
 }

actions/rules/action_field_set.go

@@ -52,7 +52,7 @@ func (act ActionFieldSet) storeWorkItem(wi *workitem.WorkItem) (*workitem.WorkIt
 }
 
 // OnChange executes the action rule.
-func (act ActionFieldSet) OnChange(newContext change.Detector, contextChanges change.Set, configuration string, actionChanges *change.Set) (change.Detector, change.Set, error) {
+func (act ActionFieldSet) OnChange(newContext change.Detector, contextChanges change.Set, configuration string, actionChanges change.Set) (change.Detector, change.Set, error) {
 	// check if the newContext is a WorkItem, fail otherwise.
 	wiContext, ok := newContext.(workitem.WorkItem)
 	if !ok {
@@ -76,7 +76,7 @@ func (act ActionFieldSet) OnChange(newContext change.Detector, contextChanges ch
 			if !ok {
 				return nil, nil, errs.New("unknown field name: " + k)
 			}
-			*actionChanges = append(*actionChanges, change.Change{
+			actionChanges = append(actionChanges, change.Change{
 				AttributeName: k,
 				NewValue:      v,
 				OldValue:      wiContext.Fields[k],
@@ -100,5 +100,5 @@ func (act ActionFieldSet) OnChange(newContext change.Detector, contextChanges ch
 			return nil, nil, errs.New("field attribute unknown: " + k)
 		}
 	}
-	return *actionResultContext, *actionChanges, nil
+	return *actionResultContext, actionChanges, nil
 }

actions/rules/action_field_set_test.go

@@ -56,7 +56,7 @@ func (s *ActionFieldSetSuite) TestActionExecution() {
 		}
 		var convertChanges change.Set
 		// Not using constants here intentionally.
-		afterActionWI, convertChanges, err := action.OnChange(newVersion, contextChanges, "{ \"system.state\": \"resolved\" }", &convertChanges)
+		afterActionWI, convertChanges, err := action.OnChange(newVersion, contextChanges, "{ \"system.state\": \"resolved\" }", convertChanges)
 		require.NoError(t, err)
 		require.Len(t, convertChanges, 1)
 		require.Equal(t, workitem.SystemState, convertChanges[0].AttributeName)
@@ -79,15 +79,15 @@ func (s *ActionFieldSetSuite) TestActionExecution() {
 		}
 		var convertChanges change.Set
 		// Not using constants here intentionally.
-		afterActionWI, convertChanges, err := action.OnChange(newVersion, contextChanges, "{ \"system.state\": \"resolved\" }", &convertChanges)
+		afterActionWI, convertChanges, err := action.OnChange(newVersion, contextChanges, "{ \"system.state\": \"resolved\" }", convertChanges)
 		require.NoError(t, err)
 		require.Len(t, convertChanges, 1)
 		require.Equal(t, workitem.SystemState, convertChanges[0].AttributeName)
 		require.Equal(t, workitem.SystemStateOpen, convertChanges[0].OldValue)
 		require.Equal(t, workitem.SystemStateResolved, convertChanges[0].NewValue)
 		require.Equal(t, workitem.SystemStateResolved, afterActionWI.(workitem.WorkItem).Fields[workitem.SystemState])
 		// doing another change, the convertChange needs to stack.
-		afterActionWI, convertChanges, err = action.OnChange(afterActionWI, change.Set{}, "{ \"system.state\": \"new\" }", &convertChanges)
+		afterActionWI, convertChanges, err = action.OnChange(afterActionWI, change.Set{}, "{ \"system.state\": \"new\" }", convertChanges)
 		require.NoError(t, err)
 		require.Len(t, convertChanges, 2)
 		require.Equal(t, workitem.SystemState, convertChanges[0].AttributeName)
@@ -112,7 +112,7 @@ func (s *ActionFieldSetSuite) TestActionExecution() {
 			UserID: &fxt.Identities[0].ID,
 		}
 		var convertChanges change.Set
-		_, _, err = action.OnChange(newVersion, contextChanges, "{ \"system.notavailable\": \"updatedState\" }", &convertChanges)
+		_, _, err = action.OnChange(newVersion, contextChanges, "{ \"system.notavailable\": \"updatedState\" }", convertChanges)
 		require.NotNil(t, err)
 	})
 
@@ -129,7 +129,7 @@ func (s *ActionFieldSetSuite) TestActionExecution() {
 			UserID: &fxt.Identities[0].ID,
 		}
 		var convertChanges change.Set
-		_, convertChanges, err = action.OnChange(newVersion, contextChanges, "someNonJSON", &convertChanges)
+		_, convertChanges, err = action.OnChange(newVersion, contextChanges, "someNonJSON", convertChanges)
 		require.NotNil(t, err)
 	})
 }

actions/rules/action_nil.go

@@ -12,6 +12,6 @@ type ActionNil struct {
 var _ Action = ActionNil{}
 
 // OnChange executes the action rule.
-func (act ActionNil) OnChange(newContext change.Detector, contextChanges change.Set, configuration string, actionChanges *change.Set) (change.Detector, change.Set, error) {
+func (act ActionNil) OnChange(newContext change.Detector, contextChanges change.Set, configuration string, actionChanges change.Set) (change.Detector, change.Set, error) {
 	return newContext, nil, nil
 }