fix: avoid id misconfiguration

docs/10_overview.md

@@ -0,0 +1,2 @@
+# Integration Connector Agent
+

docs/20_install.md

@@ -0,0 +1,22 @@
+# How to install
+
+To deploy the service, you need to configure the environment variables and a configuration.
+
+## Environment Variables
+
+The following environment variables are required to run the application.
+
+| Variable                | Required | Default | Description              |
+|-------------------------|----------|---------|--------------------------|
+| LOG_LEVEL               | ❌       | info    | Log level                 |
+| HTTP_PORT               | ❌       | 8080    | HTTP port                 |
+| HTTP_ADDRESS            | ❌       | 0.0.0.0 | HTTP address exposed by the server  |
+| SERVICE_PREFIX          | ❌       | /       | Prefix for the service endpoints (except for the status and documentation ones) |
+| DELAY_SHUTDOWN_SECONDS  | ❌       | 10      | Delay in seconds before the server shutdown. This could be important to correctly enabling the graceful shutdown in Kubernetes environments |
+| CONFIGURATION_PATH      |✅        |         | The path where it is the configuration file |
+
+## Configuration
+
+The configuration is needed to define the service behavior: the service to integrate with and where to store the data.
+
+<!-- TODO: -->

docs/integrations/20_jira.md

@@ -0,0 +1 @@
+# Jira

internal/config/config.go

@@ -76,7 +76,6 @@ type Integration struct {
 	Type           string         `json:"type"`
 	Authentication Authentication `json:"authentication"`
 	Writers        []Writer       `json:"writers"`
-	EventIDPath    string         `json:"eventIdPath"`
 }
 
 type Configuration struct {

internal/config/config.schema.json

@@ -21,9 +21,6 @@
 							}
 						}
 					},
-					"eventIdPath": {
-						"type": "string"
-					},
 					"writers": {
 						"type": "array",
 						"items": {
@@ -43,17 +40,14 @@
 										},
 										"outputEvent": {
 											"type": "object"
-										},
-										"idField": {
-											"type": "string"
 										}
 									},
 									"required": [
 										"type",
 										"url",
 										"outputEvent",
 										"collection",
-										"idField"
+										"uniqueIdKey"
 									]
 								}
 							]
@@ -62,8 +56,7 @@
 				},
 				"required": [
 					"type",
-					"writers",
-					"eventIdPath"
+					"writers"
 				]
 			},
 			"minItems": 1

internal/config/config_test.go

@@ -51,7 +51,6 @@ func TestLoadServiceConfiguration(t *testing.T) {
 						Authentication: Authentication{
 							Secret: SecretSource("MY_SECRET"),
 						},
-						EventIDPath: "issue.id",
 						Writers: []Writer{
 							{
 								Type: "mongo",
@@ -145,7 +144,6 @@ func getExpectedWriterConfig(t *testing.T) string {
 		"summary": "{{ issue.fields.summary }}",
 		"createdAt": "{{ issue.fields.created }}",
 		"description": "{{ issue.fields.description }}"
-	},
-	"idField": "key"
+	}
 }`
 }

internal/config/integration_test.go

@@ -54,7 +54,6 @@ func TestWriterConfig(t *testing.T) {
 				"createdAt":   "{{ issue.fields.created }}",
 				"description": "{{ issue.fields.description }}",
 			},
-			IDField: "key",
 		}, mongoConfig)
 	})
 }

internal/config/testdata/all-writer-config.json

@@ -7,7 +7,6 @@
 					"fromFile": "testdata/secret"
 				}
 			},
-			"eventIdPath": "issue.id",
 			"writers": [
 				{
 					"type": "mongo",
@@ -20,8 +19,7 @@
 						"summary": "{{ issue.fields.summary }}",
 						"createdAt": "{{ issue.fields.created }}",
 						"description": "{{ issue.fields.description }}"
-					},
-					"idField": "key"
+					}
 				}
 			]
 		}

internal/config/testdata/config.json

@@ -7,7 +7,6 @@
 					"fromFile": "testdata/secret"
 				}
 			},
-			"eventIdPath": "issue.id",
 			"writers": [
 				{
 					"type": "mongo",
@@ -20,8 +19,7 @@
 						"summary": "{{ issue.fields.summary }}",
 						"createdAt": "{{ issue.fields.created }}",
 						"description": "{{ issue.fields.description }}"
-					},
-					"idField": "key"
+					}
 				}
 			]
 		}

internal/integrations/jira/config.go

@@ -18,6 +18,5 @@ package jira
 // Configuration is the representation of the configuration for a Jira Cloud webhook
 type Configuration struct {
 	// Secret the webhook secret configuration for validating the data received
-	Secret      string
-	EventIDPath string
+	Secret string
 }

internal/integrations/jira/events.go

@@ -27,12 +27,15 @@ const (
 	issueCreated = "jira:issue_created"
 	issueUpdated = "jira:issue_updated"
 	issueDeleted = "jira:issue_deleted"
+
+	webhookEventFieldPath = "webhookEvent"
+	eventIDPath           = "issue.id"
 )
 
-func getPipelineEvent(rawData []byte, eventIDPath string) (entities.PipelineEvent, error) {
+func getPipelineEvent(rawData []byte) (entities.PipelineEvent, error) {
 	parsed := gjson.ParseBytes(rawData)
 	id := parsed.Get(eventIDPath).String()
-	webhookEvent := parsed.Get("webhookEvent").String()
+	webhookEvent := parsed.Get(webhookEventFieldPath).String()
 
 	operationType, err := getOperationType(webhookEvent)
 	if err != nil {

internal/integrations/jira/events_test.go

@@ -59,7 +59,7 @@ func TestEvent(t *testing.T) {
 
 	for name, tc := range testCases {
 		t.Run(name, func(t *testing.T) {
-			event, err := getPipelineEvent([]byte(tc.rawData), "issue.id")
+			event, err := getPipelineEvent([]byte(tc.rawData))
 			if tc.expectError != "" {
 				require.Error(t, err)
 				require.EqualError(t, err, tc.expectError)

internal/integrations/jira/service.go

@@ -86,7 +86,7 @@ func webhookHandler(config Configuration, p pipeline.IPipeline[entities.Pipeline
 			return c.SendStatus(http.StatusOK)
 		}
 
-		event, err := getPipelineEvent(body, config.EventIDPath)
+		event, err := getPipelineEvent(body)
 		if err != nil {
 			log.WithError(err).Error("error unmarshaling event")
 			return c.Status(http.StatusBadRequest).JSON(utils.ValidationError(err.Error()))

internal/integrations/tests/jira_test.go

@@ -71,6 +71,7 @@ func TestJiraIntegration(t *testing.T) {
 
 				expectedResults: []map[string]any{
 					{
+						"eventId":     "12345",
 						"key":         "TEST-123",
 						"createdAt":   "2024-11-06T00:00:00.000Z",
 						"description": "This is a test issue description",
@@ -100,6 +101,7 @@ func TestJiraIntegration(t *testing.T) {
 
 				expectedResults: []map[string]any{
 					{
+						"eventId":     "12345",
 						"key":         "TEST-123",
 						"createdAt":   "2024-11-06T00:00:00.000Z",
 						"description": "This is a test issue description modified",
@@ -129,12 +131,14 @@ func TestJiraIntegration(t *testing.T) {
 
 				expectedResults: []map[string]any{
 					{
+						"eventId":     "12345",
 						"key":         "TEST-123",
 						"createdAt":   "2024-11-06T00:00:00.000Z",
 						"description": "This is a test issue description modified",
 						"summary":     "Test modified issue",
 					},
 					{
+						"eventId":     "12346",
 						"key":         "TEST-456",
 						"createdAt":   "2024-11-10T00:00:00.000Z",
 						"description": "This is the second issue",
@@ -159,10 +163,11 @@ func TestJiraIntegration(t *testing.T) {
 
 				expectedResults: []map[string]any{
 					{
-						"key":         "TEST-456",
-						"createdAt":   "2024-11-10T00:00:00.000Z",
-						"description": "This is the second issue",
-						"summary":     "Test second issue",
+						"eventId":     "12345",
+						"key":         "TEST-123",
+						"createdAt":   "2024-11-06T00:00:00.000Z",
+						"description": "This is a test issue description modified",
+						"summary":     "Test modified issue",
 					},
 				},
 			},

internal/integrations/tests/testdata/jira/config.json

@@ -7,7 +7,6 @@
 					"fromFile": "testdata/secret"
 				}
 			},
-			"eventIdPath": "issue.key",
 			"writers": [
 				{
 					"type": "mongo",
@@ -20,8 +19,7 @@
 						"summary": "{{ issue.fields.summary }}",
 						"createdAt": "{{ issue.fields.created }}",
 						"description": "{{ issue.fields.description }}"
-					},
-					"idField": "key"
+					}
 				}
 			]
 		}

internal/server/integrations.go

@@ -48,8 +48,7 @@ func setupIntegrations(ctx context.Context, log *logrus.Logger, cfg *config.Conf
 		case integration.Jira:
 			// TODO: improve management of configuration
 			config := jira.Configuration{
-				Secret:      cfgIntegration.Authentication.Secret.String(),
-				EventIDPath: cfgIntegration.EventIDPath,
+				Secret: cfgIntegration.Authentication.Secret.String(),
 			}
 
 			if err := jira.SetupService(ctx, logrus.NewEntry(log), oasRouter, config, writer); err != nil {

internal/writer/mongo/config.go

@@ -27,7 +27,6 @@ type Config struct {
 	Database    string              `json:"-"`
 	Collection  string              `json:"collection"`
 	OutputEvent map[string]any      `json:"outputEvent"`
-	IDField     string              `json:"idField"`
 }
 
 func (c *Config) Validate() error {
@@ -40,14 +39,11 @@ func (c *Config) Validate() error {
 	if c.OutputEvent == nil {
 		return fmt.Errorf("outputEvent is required")
 	}
-	if c.IDField == "" {
-		return fmt.Errorf("idField is required")
+	if _, ok := c.OutputEvent["_id"]; ok {
+		return fmt.Errorf(`outputEvent "_id" field is reserved`)
 	}
-	if c.IDField == "_id" {
-		return fmt.Errorf("idField cannot be \"_id\"")
-	}
-	if _, ok := c.OutputEvent[c.IDField]; !ok {
-		return fmt.Errorf("idField \"%s\" not found in outputEvent", c.IDField)
+	if _, ok := c.OutputEvent[idField]; ok {
+		return fmt.Errorf(`outputEvent "%s" field is reserved`, idField)
 	}
 
 	return nil

internal/writer/mongo/config_test.go

@@ -50,55 +50,27 @@ func TestValidateConfig(t *testing.T) {
 
 			expectedError: "outputEvent is required",
 		},
-		"throws if IDField not found in output event": {
-			config: Config{
-				URL:         config.SecretSource("mongodb://localhost:27017"),
-				Collection:  "test",
-				OutputEvent: map[string]any{},
-				IDField:     "custom_id",
-			},
-
-			expectedError: `idField "custom_id" not found in outputEvent`,
-		},
-		"throws if IDField not set": {
-			config: Config{
-				URL:         config.SecretSource("mongodb://localhost:27017"),
-				Collection:  "test",
-				OutputEvent: map[string]any{},
-			},
-
-			expectedError: `idField is required`,
-		},
-		"set custom IDField": {
+		"throws if _id is present in OutputEvent": {
 			config: Config{
 				URL:        config.SecretSource("mongodb://localhost:27017"),
 				Collection: "test",
 				OutputEvent: map[string]any{
-					"custom_id": "my-id",
+					"_id": "my-id",
 				},
-				IDField: "custom_id",
 			},
 
-			expectedConfig: Config{
-				URL:        config.SecretSource("mongodb://localhost:27017"),
-				Collection: "test",
-				OutputEvent: map[string]any{
-					"custom_id": "my-id",
-				},
-				IDField: "custom_id",
-			},
+			expectedError: `outputEvent "_id" field is reserved`,
 		},
-		"_id not supported as IDField": {
+		"throws if uid is present in OutputEvent": {
 			config: Config{
 				URL:        config.SecretSource("mongodb://localhost:27017"),
 				Collection: "test",
 				OutputEvent: map[string]any{
-					"_id": "my-id",
+					"eventId": "my-id",
 				},
-				IDField: "_id",
 			},
 
-			expectedError: `idField cannot be "_id"`,
+			expectedError: `outputEvent "eventId" field is reserved`,
 		},
 	}
 

internal/writer/mongo/integration_test.go

@@ -40,7 +40,6 @@ func TestMongo(t *testing.T) {
 		URL:        config.SecretSource(mongoURL),
 		Database:   db,
 		Collection: collection,
-		IDField:    "key",
 	})
 	require.NoError(t, err)
 
@@ -52,7 +51,7 @@ func TestMongo(t *testing.T) {
 		err = w.Write(ctx, e)
 		require.NoError(t, err)
 		findAllDocuments(t, coll, []map[string]any{
-			{"foo": "bar", "key": "123"},
+			{"eventId": "123", "foo": "bar", "key": "123"},
 		})
 	})
 
@@ -61,7 +60,7 @@ func TestMongo(t *testing.T) {
 		err = w.Write(ctx, e)
 		require.NoError(t, err)
 		findAllDocuments(t, coll, []map[string]any{
-			{"foo": "taz", "key": "123", "another": "field"},
+			{"eventId": "123", "foo": "taz", "key": "123", "another": "field"},
 		})
 	})