refactor(api,ui): rm jabb notifications (#6036)

yesnault · web-flow · commit 3016fac8d636 · 2022-04-22T10:42:16.000+02:00
* refactor(api,ui): rm jabb notifications

kafka event have to be used to send msg on enterprise msg system

Signed-off-by: Yvonnick Esnault &lt;yvonnick.esnault@corp.ovh.com&gt;
diff --git a/docs/content/docs/concepts/files/workflow-syntax.md b/docs/content/docs/concepts/files/workflow-syntax.md
@@ -104,24 +104,6 @@ Example of email notification.
     - me@foo.bar
 ```
 
-Example of jabber notification. Note that you can add `conditions` on every notifications
-
-```yml
-- type: jabber
-  pipelines:
-  - deploy
-  settings:
-    on_start: true
-    send_to_groups: true
-    recipients:
-    - me@jabber.com
-    conditions:
-      check:
-      - variable: cds.triggered_by.email
-        operator: eq
-        value: me@localhost.local
-```
-
 Example of vcs notification. Note that `pipelines` list is optional on every notifications. When it's not specified, notification will be triggered for each pipeline
 
 ```yml
diff --git a/docs/content/docs/concepts/workflow/notifications.md b/docs/content/docs/concepts/workflow/notifications.md
@@ -10,7 +10,7 @@ On a workflow you can have 2 kinds of notifications:
 
 ## User notifications
 
-You can configure user notifications to send email or a message on jabber with different parameters. Inside the body of the notification you can customise the message thanks to the CDS variable templating with syntax like `{{.cds.myvar}}`. You can also use `HTML` to customise the message, then in order to let CDS interpret your message as an `HTML` one you just need to wrap all your message inside html tag like this `<html>MyContentHere</html>`.
+You can configure user notifications to send email with different parameters. Inside the body of the notification you can customise the message thanks to the CDS variable templating with syntax like `{{.cds.myvar}}`. You can also use `HTML` to customise the message, then in order to let CDS interpret your message as an `HTML` one you just need to wrap all your message inside html tag like this `<html>MyContentHere</html>`.
 
 ## VCS Notifications
 
diff --git a/engine/api/notification.go b/engine/api/notification.go
@@ -19,14 +19,6 @@ func (api *API) getUserNotificationTypeHandler() service.Handler {
 				SendToGroups: &sdk.False,
 				Template:     &sdk.UserNotificationTemplateEmail,
 			},
-			sdk.JabberUserNotification: {
-				OnSuccess:    sdk.UserNotificationChange,
-				OnFailure:    sdk.UserNotificationAlways,
-				OnStart:      &sdk.False,
-				SendToAuthor: &sdk.True,
-				SendToGroups: &sdk.False,
-				Template:     &sdk.UserNotificationTemplateJabber,
-			},
 			sdk.VCSUserNotification: {
 				Template: &sdk.UserNotificationTemplate{
 					Body: sdk.DefaultWorkflowNodeRunReport,
diff --git a/engine/api/notification/user.go b/engine/api/notification/user.go
@@ -57,50 +57,18 @@ func GetUserWorkflowEvents(ctx context.Context, db gorp.SqlExecutor, store cache
 	for _, notif := range notifs {
 		if ShouldSendUserWorkflowNotification(ctx, notif, nr, previousWR) {
 			switch notif.Type {
-			case sdk.JabberUserNotification:
-				jn := &notif.Settings
-				//Get recipents from groups
-				if jn.SendToGroups != nil && *jn.SendToGroups {
-					u, err := projectPermissionUserIDs(ctx, db, store, projectID, sdk.PermissionRead)
-					if err != nil {
-						log.Error(ctx, "notification[Jabber]. error while loading permission: %v", err)
-						break
-					}
-					users, err := user.LoadAllByIDs(ctx, db, u)
-					if err != nil {
-						log.Error(ctx, "notification[Jabber]. error while loading users: %v", err)
-						break
-					}
-					for _, u := range users {
-						jn.Recipients = append(jn.Recipients, u.Username)
-					}
-				}
-				if jn.SendToAuthor == nil || *jn.SendToAuthor {
-					if author, ok := params[paramsAuthorEmail]; ok {
-						jn.Recipients = append(jn.Recipients, author)
-					}
-				}
-
-				//Finally deduplicate everyone
-				removeDuplicates(&jn.Recipients)
-				notif, err := getWorkflowEvent(jn, params)
-				if err != nil {
-					log.Error(ctx, "notification.GetUserWorkflowEvents> unable to handle event %+v: %v", jn, err)
-				}
-				events = append(events, notif)
-
 			case sdk.EmailUserNotification:
 				jn := &notif.Settings
 				//Get recipents from groups
 				if jn.SendToGroups != nil && *jn.SendToGroups {
 					u, err := projectPermissionUserIDs(ctx, db, store, projectID, sdk.PermissionRead)
 					if err != nil {
-						log.Error(ctx, "notification[Email].GetUserWorkflowEvents> error while loading permission: %v", err)
+						log.Error(ctx, "error while loading permission: %v", err)
 						return nil
 					}
 					contacts, err := user.LoadContactsByUserIDs(ctx, db, u)
 					if err != nil {
-						log.Error(ctx, "notification[Jabber]. error while loading users contacts: %v", err)
+						log.Error(ctx, "error while loading users contacts: %v", err)
 						break
 					}
 					for _, c := range contacts {
diff --git a/engine/api/workflow/dao_test.go b/engine/api/workflow/dao_test.go
@@ -1158,7 +1158,7 @@ func TestInsertComplexeWorkflowWithComplexeJoins(t *testing.T) {
 		},
 		Notifications: []sdk.WorkflowNotification{
 			{
-				Type:           "jabber",
+				Type:           "email",
 				SourceNodeRefs: []string{"pip6", "pip5"},
 				Settings: sdk.UserNotificationSettings{
 					OnFailure:    sdk.UserNotificationAlways,
diff --git a/engine/api/workflow_ascode_test.go b/engine/api/workflow_ascode_test.go
@@ -717,7 +717,7 @@ metadata:
   default_tags: tag_version,git.branch,git.author
 notifications:
 - type: vcs
-- type: jabber
+- type: email
   pipelines:
   - playbook-game-stuff
   - playbook-game-molecule
@@ -732,7 +732,7 @@ notifications:
         {{.cds.status}}'
       body: |
         {{.cds.buildURL}}
-- type: jabber
+- type: email
   pipelines:
   - notify
   settings:
@@ -748,7 +748,7 @@ notifications:
       - variable: git.branch
         operator: eq
         value: master
-- type: jabber
+- type: email
   pipelines:
   - notify
   settings:
diff --git a/engine/sql/api/240_delete_notif_jabber.sql b/engine/sql/api/240_delete_notif_jabber.sql
@@ -0,0 +1,5 @@
+-- +migrate Up
+delete from workflow_notification where type = 'jabber';
+
+-- +migrate Down
+SELECT 1;
diff --git a/sdk/exportentities/v1/workflow_notif_test.go b/sdk/exportentities/v1/workflow_notif_test.go
@@ -1,10 +1,11 @@
 package v1_test
 
 import (
-	v1 "github.com/ovh/cds/sdk/exportentities/v1"
 	"reflect"
 	"testing"
 
+	v1 "github.com/ovh/cds/sdk/exportentities/v1"
+
 	"github.com/ovh/cds/engine/api/test"
 	"github.com/ovh/cds/sdk"
 	yaml "gopkg.in/yaml.v2"
@@ -48,7 +49,7 @@ metadata:
   default_tags: git.branch,git.author
 notifications:
   DDOS-me,DDOS-me_2:
-  - type: jabber
+  - type: email
     settings:
       on_success: always
       on_failure: change
diff --git a/sdk/exportentities/v2/workflow_notif_test.go b/sdk/exportentities/v2/workflow_notif_test.go
@@ -52,7 +52,7 @@ workflow:
 metadata:
   default_tags: git.branch,git.author
 notifications:
-- type: jabber
+- type: email
   pipelines:
   - DDOS-me
   - DDOS-me_2
@@ -158,7 +158,7 @@ workflow:
     - success
     pipeline: test
 notifications:
-- type: jabber
+- type: email
   pipelines:
   - test
   - test_2
@@ -198,7 +198,7 @@ notifications:
         Details : {{.cds.buildURL}}
         Triggered by : {{.cds.triggered_by.username}}
         Branch : {{.git.branch}}
-- type: jabber
+- type: email
   pipelines:
   - test
   - test_2
@@ -231,7 +231,7 @@ workflow:
     - success
     pipeline: test
 notifications:
-- type: jabber
+- type: email
 - type: event
   integration: my-integration
 `,
diff --git a/sdk/notif.go b/sdk/notif.go
@@ -13,10 +13,9 @@ import (
 
 //const
 const (
-	EmailUserNotification  = "email"
-	JabberUserNotification = "jabber"
-	VCSUserNotification    = "vcs"
-	EventsNotification     = "event"
+	EmailUserNotification = "email"
+	VCSUserNotification   = "vcs"
+	EventsNotification    = "event"
 )
 
 //const
@@ -35,7 +34,7 @@ type UserNotification struct {
 	Notifications         map[string]UserNotificationSettings `json:"notifications"`
 }
 
-// UserNotificationSettings are jabber or email settings
+// UserNotificationSettings --> email settings
 type UserNotificationSettings struct {
 	OnSuccess    string                    `json:"on_success,omitempty" yaml:"on_success,omitempty"`         // default is "onChange", empty means onChange
 	OnFailure    string                    `json:"on_failure,omitempty" yaml:"on_failure,omitempty"`         // default is "always", empty means always
@@ -96,14 +95,8 @@ Triggered by : {{.cds.triggered_by.username}}
 Branch : {{.git.branch | default "n/a"}}`,
 	}
 
-	UserNotificationTemplateJabber = UserNotificationTemplate{
-		Subject: "{{.cds.project}}/{{.cds.workflow}}#{{.cds.version}} {{.cds.status}}",
-		Body:    `{{.cds.buildURL}}`,
-	}
-
 	UserNotificationTemplateMap = map[string]UserNotificationTemplate{
-		EmailUserNotification:  UserNotificationTemplateEmail,
-		JabberUserNotification: UserNotificationTemplateJabber,
+		EmailUserNotification: UserNotificationTemplateEmail,
 		VCSUserNotification: {
 			Body: DefaultWorkflowNodeRunReport,
 		},
diff --git a/ui/src/app/model/workflow.model.ts b/ui/src/app/model/workflow.model.ts
@@ -687,7 +687,7 @@ export class WorkflowPull {
     environments: Array<string>;
 }
 
-export const notificationTypes = ['jabber', 'email', 'vcs'];
+export const notificationTypes = ['email', 'vcs'];
 export const notificationOnSuccess = ['always', 'change', 'never'];
 export const notificationOnFailure = ['always', 'change', 'never'];
 
diff --git a/ui/src/app/views/workflow/show/notification/form/workflow.notifications.form.html b/ui/src/app/views/workflow/show/notification/form/workflow.notifications.form.html
@@ -29,7 +29,7 @@
                     [readonly]="true">
             </div>
         </div>
-        <ng-container *ngIf="notification.type === 'jabber' || notification.type === 'email'">
+        <ng-container *ngIf="notification.type === 'email'">
             <div class="three fields">
                 <div class="six wide field">
                     <label>{{ 'workflow_notification_on_success' | translate}}</label>
@@ -64,8 +64,6 @@
             </div>
             <div class="three fields">
                 <div class="eight wide field">
-                    <label
-                        *ngIf="notification.type === 'jabber'">{{ 'workflow_notification_jabber_user' | translate}}</label>
                     <label
                         *ngIf="notification.type === 'email'">{{ 'workflow_notification_email_user' | translate}}</label>
                     <input type="text" name="users" [(ngModel)]="selectedUsers" [readonly]="readOnly">
diff --git a/ui/src/assets/i18n/en.json b/ui/src/assets/i18n/en.json
@@ -855,7 +855,6 @@
   "workflow_notification_body": "Message",
   "workflow_notification_to_group": "Send to group",
   "workflow_notification_to_initiator": "Send to initiator",
-  "workflow_notification_jabber_user": "Jabber users",
   "workflow_notification_email_user": "Mails",
   "workflow_notification_form": "Add a notification",
   "workflow_notification_copy": "Copy",

Original file line number	Diff line number	Diff line change
`@@ -1158,7 +1158,7 @@ func TestInsertComplexeWorkflowWithComplexeJoins(t *testing.T) {`
`1158`	`1158`	`},`
`1159`	`1159`	`Notifications: []sdk.WorkflowNotification{`
`1160`	`1160`	`{`
`1161`		`- Type: "jabber",`
	`1161`	`+ Type: "email",`
`1162`	`1162`	`SourceNodeRefs: []string{"pip6", "pip5"},`
`1163`	`1163`	`Settings: sdk.UserNotificationSettings{`
`1164`	`1164`	`OnFailure: sdk.UserNotificationAlways,`
Original file line number	Diff line number	Diff line change
`@@ -687,7 +687,7 @@ export class WorkflowPull {`
`687`	`687`	`environments: Array<string>;`
`688`	`688`	`}`
`689`	`689`
`690`		`-export const notificationTypes = ['jabber', 'email', 'vcs'];`
	`690`	`+export const notificationTypes = ['email', 'vcs'];`
`691`	`691`	`export const notificationOnSuccess = ['always', 'change', 'never'];`
`692`	`692`	`export const notificationOnFailure = ['always', 'change', 'never'];`
`693`	`693`