Add project test notification API endpoint (#3208)

* Add test notification endpoint for project alerts

Co-authored-by: denguk <[email protected]>

* fix(test-notif): add user list for email notification testing

* feat(test-notif): add more informative error message

* feat(ui): add progress to test notifications

* docs: fix test endpoint

---------

Co-authored-by: Cursor Agent <[email protected]>

Author: fiftin

.dredd/hooks/main.go

@@ -19,6 +19,7 @@ var skipTests = []string{
 	"/api/ws > Websocket handler > 200 > application/json",
 	"authentication > /api/auth/login > Performs Login > 204 > application/json",
 	"authentication > /api/auth/logout > Destroys current session > 204 > application/json",
+	"/project/{project_id}/notifications/test",
 	//"/api/upgrade > Upgrade the server > 200 > application/json",
 	// TODO - Skipping this while we work out how to get a 204 response from the api for testing
 	//"/api/upgrade > Check if new updates available and fetch /info > 204 > application/json",

api-docs.yml

@@ -2499,4 +2499,18 @@ paths:
           schema:
             type: array
             items:
-              $ref: "#/definitions/App"
+              $ref: "#/definitions/App"
+
+  /project/{project_id}/notifications/test:
+    post:
+      tags:
+        - project
+      summary: Send test notification
+      description: Sends a test notification to all enabled messengers for the project
+      parameters:
+        - $ref: "#/parameters/project_id"
+      responses:
+        409:
+          description: Alerts not enabled for the project
+#        204:
+#          description: Test notification dispatched (or alerts disabled)

api/projects/project.go

@@ -1,13 +1,15 @@
 package projects
 
 import (
+	"net/http"
+
 	"github.com/gorilla/mux"
 	"github.com/semaphoreui/semaphore/api/helpers"
 	"github.com/semaphoreui/semaphore/db"
 	"github.com/semaphoreui/semaphore/services/server"
+	"github.com/semaphoreui/semaphore/services/tasks"
 	"github.com/semaphoreui/semaphore/util"
 	log "github.com/sirupsen/logrus"
-	"net/http"
 )
 
 // ProjectMiddleware ensures a project exists and loads it to the context
@@ -66,6 +68,25 @@ type ProjectController struct {
 	ProjectService server.ProjectService
 }
 
+// SendTestNotification triggers sending a test notification to enabled messengers for this project.
+func (c *ProjectController) SendTestNotification(w http.ResponseWriter, r *http.Request) {
+	project := helpers.GetFromContext(r, "project").(db.Project)
+
+	// Respect project.Alert flag: if disabled, still return 204 without sending
+	if !project.Alert {
+		w.WriteHeader(http.StatusConflict)
+		return
+	}
+
+	err := tasks.SendProjectTestAlerts(project, helpers.Store(r))
+	if err != nil {
+		helpers.WriteError(w, err)
+		return
+	}
+
+	w.WriteHeader(http.StatusNoContent)
+}
+
 func (c *ProjectController) UpdateProject(w http.ResponseWriter, r *http.Request) {
 	project := helpers.GetFromContext(r, "project").(db.Project)
 	var body db.Project

api/router.go

@@ -319,6 +319,7 @@ func Route(
 	projectUserAPI.Path("/integrations").HandlerFunc(projects.GetIntegrations).Methods("GET", "HEAD")
 	projectUserAPI.Path("/integrations").HandlerFunc(projects.AddIntegration).Methods("POST")
 	projectUserAPI.Path("/backup").HandlerFunc(projects.GetBackup).Methods("GET", "HEAD")
+	projectUserAPI.Path("/notifications/test").HandlerFunc(projectController.SendTestNotification).Methods("POST")
 
 	projectUserAPI.Path("/runners").HandlerFunc(projectRunnerController.GetRunners).Methods("GET", "HEAD")
 	projectUserAPI.Path("/runners").HandlerFunc(projectRunnerController.AddRunner).Methods("POST")

services/tasks/alert_test_sender.go

@@ -0,0 +1,52 @@
+package tasks
+
+import (
+	"github.com/semaphoreui/semaphore/db"
+	"github.com/semaphoreui/semaphore/pkg/task_logger"
+)
+
+// SendProjectTestAlerts sends test alerts to all enabled notifiers for the given project.
+func SendProjectTestAlerts(project db.Project, store db.Store) (err error) {
+
+	projectUsers, err := store.GetProjectUsers(project.ID, db.RetrieveQueryParams{})
+	if err != nil {
+		return
+	}
+
+	var userIDs []int
+	for _, u := range projectUsers {
+		userIDs = append(userIDs, u.ID)
+	}
+
+	tr := &TaskRunner{
+		Task: db.Task{
+			ProjectID:  project.ID,
+			TemplateID: 0,
+			Status:     task_logger.TaskSuccessStatus,
+			Message:    "This is a test notification",
+		},
+		Template: db.Template{
+			ID:        0,
+			ProjectID: project.ID,
+			Name:      "Test Notification",
+			Type:      db.TemplateTask,
+		},
+		users:     userIDs,
+		alert:     project.Alert,
+		alertChat: project.AlertChat,
+		pool: &TaskPool{
+			logger: make(chan logRecord, 100),
+			store:  store,
+		},
+	}
+
+	tr.sendTelegramAlert()
+	tr.sendSlackAlert()
+	tr.sendRocketChatAlert()
+	tr.sendMicrosoftTeamsAlert()
+	tr.sendDingTalkAlert()
+	tr.sendGotifyAlert()
+	tr.sendMailAlert()
+
+	return
+}

web/public/swagger/api-docs.yml

@@ -1573,6 +1573,20 @@ paths:
             items:
               $ref: '#/definitions/Event'
 
+  /project/{project_id}/notifications/test:
+    post:
+      summary: Send test notification
+      description: Sends a test notification to all enabled messengers for the project
+      parameters:
+        - $ref: "#/parameters/project_id"
+      responses:
+        204:
+          description: Test notification dispatched (or alerts disabled)
+        401:
+          description: not authenticated
+        403:
+          description: forbidden
+
   # User management
   /project/{project_id}/users:
     parameters:

web/src/views/project/Settings.vue

@@ -37,9 +37,26 @@
           />
         </div>
 
-        <div class="text-right">
+        <div class="d-flex justify-space-between mt-4">
+          <v-btn
+            color="blue-grey"
+            @click="sendTestNotification()"
+            width="170"
+            :disabled="testNotificationProgress"
+            data-testid="settings-testAlerts"
+          >Test Alerts</v-btn>
           <v-btn color="primary" @click="saveProject()">{{ $t('save') }}</v-btn>
         </div>
+
+        <v-progress-linear
+          v-if="testNotificationProgress"
+          color="blue-grey darken-1"
+          indeterminate
+          rounded
+          width="170"
+          height="36"
+          style="margin-top: -36px; width: 170px;"
+        ></v-progress-linear>
       </div>
 
       <h2 class="mt-8 mb-1">{{ $t('danger_zone_settings') }}</h2>
@@ -167,10 +184,40 @@ export default {
       deleteProjectDialog: null,
       backupProgress: false,
       clearCacheProgress: false,
+      testNotificationProgress: false,
     };
   },
 
   methods: {
+    async sendTestNotification() {
+      this.testNotificationProgress = true;
+      try {
+        await axios({
+          method: 'post',
+          url: `/api/project/${this.projectId}/notifications/test`,
+          responseType: 'json',
+        });
+        EventBus.$emit('i-snackbar', {
+          color: 'success',
+          text: 'Test notification sent.',
+        });
+      } catch (err) {
+        let msg;
+        if (err.response.status === 409) {
+          msg = 'Please allow alerts for the project and save it.';
+        } else {
+          msg = getErrorMessage(err);
+        }
+
+        EventBus.$emit('i-snackbar', {
+          color: 'error',
+          text: msg,
+        });
+      } finally {
+        this.testNotificationProgress = false;
+      }
+    },
+
     showDrawer() {
       EventBus.$emit('i-show-drawer');
     },