Merge pull request #14 from VersusControl/feature/add-query-params

(feature): add query parameters overwrite config

Author: hoalongnatsu

README.md

@@ -390,6 +390,13 @@ curl -X POST http://localhost:3000/api/incidents \
 
 ![Slack Alert](src/docs/images/versus-result.png)
 
+## Advanced API Usage
+We provide a way to overwrite configuration values using query parameters, allowing you to send alerts to different channel IDs based on the service.
+
+| Query          | Description |
+|------------------|-------------|
+| `slack_channel_id`   | The ID of the Slack channel where alerts will be sent. Use: `/api/incidents?slack_channel_id=<your_vaule>` |
+
 ## Roadmap
 
 - [x] Add Telegram support

pkg/common/clone_config.go

@@ -0,0 +1,102 @@
+package common
+
+func cloneConfig(src *Config) *Config {
+	if src == nil {
+		return nil
+	}
+
+	// Create a new Config and copy all fields
+	cloned := &Config{
+		Name:  src.Name,
+		Host:  src.Host,
+		Port:  src.Port,
+		Alert: cloneAlertConfig(src.Alert),
+		Queue: cloneQueueConfig(src.Queue),
+	}
+
+	return cloned
+}
+
+// Helper function to deep clone the AlertConfig struct
+func cloneAlertConfig(src AlertConfig) AlertConfig {
+	return AlertConfig{
+		DebugBody: src.DebugBody,
+		Slack:     cloneSlackConfig(src.Slack),
+		Telegram:  cloneTelegramConfig(src.Telegram),
+		Email:     cloneEmailConfig(src.Email),
+	}
+}
+
+// Helper function to deep clone the SlackConfig struct
+func cloneSlackConfig(src SlackConfig) SlackConfig {
+	return SlackConfig{
+		Enable:       src.Enable,
+		Token:        src.Token,
+		ChannelID:    src.ChannelID,
+		TemplatePath: src.TemplatePath,
+	}
+}
+
+// Helper function to deep clone the TelegramConfig struct
+func cloneTelegramConfig(src TelegramConfig) TelegramConfig {
+	return TelegramConfig{
+		Enable:       src.Enable,
+		BotToken:     src.BotToken,
+		ChatID:       src.ChatID,
+		TemplatePath: src.TemplatePath,
+	}
+}
+
+// Helper function to deep clone the EmailConfig struct
+func cloneEmailConfig(src EmailConfig) EmailConfig {
+	return EmailConfig{
+		Enable:       src.Enable,
+		SMTPHost:     src.SMTPHost,
+		SMTPPort:     src.SMTPPort,
+		Username:     src.Username,
+		Password:     src.Password,
+		To:           src.To,
+		Subject:      src.Subject,
+		TemplatePath: src.TemplatePath,
+	}
+}
+
+// Helper function to deep clone the QueueConfig struct
+func cloneQueueConfig(src QueueConfig) QueueConfig {
+	return QueueConfig{
+		Enable: src.Enable,
+		SNS:    cloneSNSConfig(src.SNS),
+		SQS:    cloneSQSConfig(src.SQS),
+		PubSub: clonePubSubConfig(src.PubSub),
+		AzBus:  cloneAzBusConfig(src.AzBus),
+	}
+}
+
+// Helper function to deep clone the SNSConfig struct
+func cloneSNSConfig(src SNSConfig) SNSConfig {
+	return SNSConfig{
+		Enable: src.Enable,
+	}
+}
+
+// Helper function to deep clone the SQSConfig struct
+func cloneSQSConfig(src SQSConfig) SQSConfig {
+	return SQSConfig{
+		Enable:   src.Enable,
+		QueueURL: src.QueueURL,
+	}
+}
+
+// Helper function to deep clone the PubSubConfig struct
+func clonePubSubConfig(src PubSubConfig) PubSubConfig {
+	return PubSubConfig{
+		Enable: src.Enable,
+	}
+}
+
+// Helper function to deep clone the AzBusConfig struct
+func cloneAzBusConfig(src AzBusConfig) AzBusConfig {
+	return AzBusConfig{
+		Enable: src.Enable,
+	}
+}

pkg/common/config.go

@@ -132,3 +132,14 @@ func GetConfig() *Config {
 	}
 	return cfg
 }
+
+func GetConfigWitParamsOverwrite(paramsOverwrite *map[string]string) *Config {
+	// Clone the global cfg
+	clonedCfg := cloneConfig(cfg)
+
+	if v := (*paramsOverwrite)["slack_channel_id"]; v != "" {
+		clonedCfg.Alert.Slack.ChannelID = v
+	}
+
+	return clonedCfg
+}

pkg/controllers/incident.go

@@ -24,7 +24,16 @@ func CreateIncident(c *fiber.Ctx) error {
 		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": "Invalid input"})
 	}
 
-	err := services.CreateIncident("", body)
+	var err error
+
+	// If query parameters exist, get the value to overwrite the default configuration
+	if len(c.Queries()) > 0 {
+		overwriteVaule := c.Queries()
+		err = services.CreateIncident("", body, &overwriteVaule)
+	} else {
+		err = services.CreateIncident("", body)
+	}
+
 	if err != nil {
 		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{"error": err.Error()})
 	}

pkg/services/incident.go

@@ -7,9 +7,16 @@ import (
 	m "versus-incident/pkg/models"
 )
 
-func CreateIncident(teamID string, content interface{}) error {
+func CreateIncident(teamID string, content interface{}, params ...*map[string]string) error {
+	var cfg *common.Config
+
+	if len(params) > 0 {
+		cfg = common.GetConfigWitParamsOverwrite(params[0])
+	} else {
+		cfg = common.GetConfig()
+	}
+
 	incident := m.NewIncident(teamID, content)
-	cfg := common.GetConfig()
 
 	factory := common.NewProviderFactory(cfg)
 	providers, err := factory.CreateProviders()

src/getting_started.md

@@ -355,4 +355,11 @@ curl -X POST http://localhost:3000/api/incidents \
 
 ## Result
 
-![Slack Alert](docs/images/versus-result.png)
+![Slack Alert](docs/images/versus-result.png)
+
+## Advanced API Usage
+We provide a way to overwrite configuration values using query parameters, allowing you to send alerts to different channel IDs based on the service.
+
+| Query          | Description |
+|------------------|-------------|
+| `slack_channel_id`   | The ID of the Slack channel where alerts will be sent. Use: `/api/incidents?slack_channel_id=<your_vaule>` |