feat: notification system for container and image updates #730
+7,010
−170
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "net/http" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/ofkm/arcane-backend/internal/dto" | ||
| "github.com/ofkm/arcane-backend/internal/middleware" | ||
| "github.com/ofkm/arcane-backend/internal/services" | ||
| ) | ||
|
|
||
| type NotificationHandler struct { | ||
| notificationService *services.NotificationService | ||
| } | ||
|
|
||
| func NewNotificationHandler(group *gin.RouterGroup, notificationService *services.NotificationService, authMiddleware *middleware.AuthMiddleware) { | ||
| handler := &NotificationHandler{ | ||
| notificationService: notificationService, | ||
| } | ||
|
|
||
| notifications := group.Group("/environments/:id/notifications") | ||
| notifications.Use(authMiddleware.WithAdminRequired().Add()) | ||
| { | ||
| notifications.GET("/settings", handler.GetAllSettings) | ||
| notifications.GET("/settings/:provider", handler.GetSettings) | ||
| notifications.POST("/settings", handler.CreateOrUpdateSettings) | ||
| notifications.DELETE("/settings/:provider", handler.DeleteSettings) | ||
| notifications.POST("/test/:provider", handler.TestNotification) | ||
| } | ||
| } | ||
|
|
||
| func (h *NotificationHandler) GetAllSettings(c *gin.Context) { | ||
| settings, err := h.notificationService.GetAllSettings(c.Request.Context()) | ||
|
There was a problem hiding this comment. style: Consider extracting environment ID from URL path if notifications should be environment-scoped: Prompt To Fix With AIThis is a comment left during a code review.
Path: backend/internal/api/notification_handler.go
Line: 33:33
Comment:
**style:** Consider extracting environment ID from URL path if notifications should be environment-scoped: `envID := c.Param("id")`
How can I resolve this? If you propose a fix, please make it concise. |
||
| if err != nil { | ||
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
|
|
||
| // Map to DTOs | ||
| responses := make([]dto.NotificationSettingsResponse, len(settings)) | ||
| for i, setting := range settings { | ||
| responses[i] = dto.NotificationSettingsResponse{ | ||
| ID: setting.ID, | ||
| Provider: setting.Provider, | ||
| Enabled: setting.Enabled, | ||
| Config: setting.Config, | ||
| } | ||
| } | ||
|
|
||
| c.JSON(http.StatusOK, responses) | ||
| } | ||
|
|
||
| func (h *NotificationHandler) GetSettings(c *gin.Context) { | ||
| provider := c.Param("provider") | ||
|
|
||
| settings, err := h.notificationService.GetSettingsByProvider(c.Request.Context(), provider) | ||
| if err != nil { | ||
| c.JSON(http.StatusNotFound, gin.H{"error": "Settings not found"}) | ||
| return | ||
| } | ||
|
|
||
| response := dto.NotificationSettingsResponse{ | ||
| ID: settings.ID, | ||
| Provider: settings.Provider, | ||
| Enabled: settings.Enabled, | ||
| Config: settings.Config, | ||
| } | ||
|
|
||
| c.JSON(http.StatusOK, response) | ||
| } | ||
|
|
||
| func (h *NotificationHandler) CreateOrUpdateSettings(c *gin.Context) { | ||
| var req dto.NotificationSettingsRequest | ||
| if err := c.ShouldBindJSON(&req); err != nil { | ||
| c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
|
|
||
| settings, err := h.notificationService.CreateOrUpdateSettings( | ||
| c.Request.Context(), | ||
| req.Provider, | ||
| req.Enabled, | ||
| req.Config, | ||
| ) | ||
| if err != nil { | ||
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
|
|
||
| response := dto.NotificationSettingsResponse{ | ||
| ID: settings.ID, | ||
| Provider: settings.Provider, | ||
| Enabled: settings.Enabled, | ||
| Config: settings.Config, | ||
| } | ||
|
|
||
| c.JSON(http.StatusOK, response) | ||
| } | ||
|
|
||
| func (h *NotificationHandler) DeleteSettings(c *gin.Context) { | ||
| provider := c.Param("provider") | ||
|
|
||
| if err := h.notificationService.DeleteSettings(c.Request.Context(), provider); err != nil { | ||
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
|
|
||
| c.JSON(http.StatusOK, gin.H{"message": "Settings deleted successfully"}) | ||
| } | ||
|
|
||
| func (h *NotificationHandler) TestNotification(c *gin.Context) { | ||
| provider := c.Param("provider") | ||
| testType := c.DefaultQuery("type", "simple") // "simple" or "image-update" | ||
|
|
||
| if err := h.notificationService.TestNotification(c.Request.Context(), provider, testType); err != nil { | ||
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
|
|
||
| c.JSON(http.StatusOK, gin.H{"message": "Test notification sent successfully"}) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package dto | ||
|
|
||
| import "github.com/ofkm/arcane-backend/internal/models" | ||
|
|
||
| type NotificationSettingsRequest struct { | ||
| Provider string `json:"provider" binding:"required"` | ||
| Enabled bool `json:"enabled"` | ||
| Config models.JSON `json:"config" binding:"required"` | ||
| } | ||
|
|
||
| type NotificationSettingsResponse struct { | ||
| ID uint `json:"id"` | ||
| Provider string `json:"provider"` | ||
| Enabled bool `json:"enabled"` | ||
| Config models.JSON `json:"config"` | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| package models | ||
|
|
||
| import ( | ||
| "time" | ||
| ) | ||
|
|
||
| type NotificationProvider string | ||
|
|
||
| const ( | ||
| NotificationProviderDiscord NotificationProvider = "discord" | ||
| NotificationProviderEmail NotificationProvider = "email" | ||
| ) | ||
|
|
||
| type EmailTLSMode string | ||
|
|
||
| const ( | ||
| EmailTLSModeNone EmailTLSMode = "none" | ||
| EmailTLSModeStartTLS EmailTLSMode = "starttls" | ||
| EmailTLSModeSSL EmailTLSMode = "ssl" | ||
| ) | ||
|
|
||
| type NotificationSettings struct { | ||
| ID uint `json:"id" gorm:"primaryKey"` | ||
| Provider string `json:"provider" gorm:"not null;index"` | ||
|
There was a problem hiding this comment. style: Provider field should use NotificationProvider type instead of string for better type safety and validation Context Used: Rule from Follow idiomatic Go patterns and conventions Prompt To Fix With AIThis is a comment left during a code review.
Path: backend/internal/models/notification.go
Line: 24:24
Comment:
**style:** Provider field should use NotificationProvider type instead of string for better type safety and validation
**Context Used:** Rule from `dashboard` - GoLang Best Practices
Follow idiomatic Go patterns and conventions
Handle errors explicitly, don’t ... ([source](https://app.greptile.com/review/custom-context?memory=214b40a8-9695-4738-986d-5949b5d65ff1))
How can I resolve this? If you propose a fix, please make it concise. |
||
| Enabled bool `json:"enabled" gorm:"default:false"` | ||
| Config JSON `json:"config" gorm:"type:jsonb"` | ||
| CreatedAt time.Time `json:"createdAt"` | ||
| UpdatedAt time.Time `json:"updatedAt"` | ||
| } | ||
|
|
||
| func (NotificationSettings) TableName() string { | ||
| return "notification_settings" | ||
| } | ||
|
|
||
| type NotificationLog struct { | ||
| ID uint `json:"id" gorm:"primaryKey"` | ||
| Provider string `json:"provider" gorm:"not null;index"` | ||
|
There was a problem hiding this comment. style: Provider field should use NotificationProvider type instead of string for consistency Context Used: Rule from Follow idiomatic Go patterns and conventions Prompt To Fix With AIThis is a comment left during a code review.
Path: backend/internal/models/notification.go
Line: 37:37
Comment:
**style:** Provider field should use NotificationProvider type instead of string for consistency
**Context Used:** Rule from `dashboard` - GoLang Best Practices
Follow idiomatic Go patterns and conventions
Handle errors explicitly, don’t ... ([source](https://app.greptile.com/review/custom-context?memory=214b40a8-9695-4738-986d-5949b5d65ff1))
How can I resolve this? If you propose a fix, please make it concise. |
||
| ImageRef string `json:"imageRef" gorm:"not null"` | ||
| Status string `json:"status" gorm:"not null"` | ||
| Error *string `json:"error,omitempty"` | ||
| Metadata JSON `json:"metadata" gorm:"type:jsonb"` | ||
| SentAt time.Time `json:"sentAt" gorm:"not null;index"` | ||
| CreatedAt time.Time `json:"createdAt"` | ||
| UpdatedAt time.Time `json:"updatedAt"` | ||
| } | ||
|
|
||
| func (NotificationLog) TableName() string { | ||
| return "notification_logs" | ||
| } | ||
|
|
||
| type DiscordConfig struct { | ||
| WebhookURL string `json:"webhookUrl"` | ||
| Username string `json:"username,omitempty"` | ||
| AvatarURL string `json:"avatarUrl,omitempty"` | ||
| } | ||
|
|
||
| type EmailConfig struct { | ||
| SMTPHost string `json:"smtpHost"` | ||
| SMTPPort int `json:"smtpPort"` | ||
| SMTPUsername string `json:"smtpUsername"` | ||
| SMTPPassword string `json:"smtpPassword"` | ||
| FromAddress string `json:"fromAddress"` | ||
| ToAddresses []string `json:"toAddresses"` | ||
| TLSMode EmailTLSMode `json:"tlsMode"` | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: The
:idparameter from the environment route is never used in any handler methods, creating inconsistency between the API design and implementationPrompt To Fix With AI