Add Source schema settings to Source resource (#71)

Author: deanhuynh

docs/data-sources/source.md

@@ -35,6 +35,7 @@ data "segment_source" "my_source" {
 - `enabled` (Boolean) Enable to receive data from the Source.
 - `labels` (Attributes List) A list of labels applied to the Source. (see [below for nested schema](#nestedatt--labels))
 - `metadata` (Attributes) The metadata for the Source. (see [below for nested schema](#nestedatt--metadata))
+- `schema_settings` (Attributes) The schema settings associated with the Source. (see [below for nested schema](#nestedatt--schema_settings))
 - `settings` (String) The settings associated with the Source.
 - `slug` (String) The slug used to identify the Source in the Segment app.
 - `workspace_id` (String) The id of the Workspace that owns the Source.
@@ -45,7 +46,6 @@ data "segment_source" "my_source" {
 
 Read-Only:
 
-- `description` (String) An optional description of the purpose of this label.
 - `key` (String) The key that represents the name of this label.
 - `value` (String) The value associated with the key of this label.
 
@@ -85,3 +85,47 @@ Read-Only:
 - `name` (String) The name identifying this option in the context of a Segment Integration.
 - `required` (Boolean) Whether this is a required option when setting up the Integration.
 - `type` (String) Defines the type for this option in the schema. Types are most commonly strings, but may also represent other primitive types, such as booleans, and numbers, as well as complex types, such as objects and arrays.
+
+
+
+<a id="nestedatt--schema_settings"></a>
+### Nested Schema for `schema_settings`
+
+Read-Only:
+
+- `forwarding_blocked_events_to` (String) Source id to forward blocked events to.
+- `forwarding_violations_to` (String) Source id to forward violations to.
+- `group` (Attributes) Group settings. (see [below for nested schema](#nestedatt--schema_settings--group))
+- `identify` (Attributes) Identify settings. (see [below for nested schema](#nestedatt--schema_settings--identify))
+- `track` (Attributes) Track settings. (see [below for nested schema](#nestedatt--schema_settings--track))
+
+<a id="nestedatt--schema_settings--group"></a>
+### Nested Schema for `schema_settings.group`
+
+Read-Only:
+
+- `allow_traits_on_violations` (Boolean) Enable to allow group traits on violations.
+- `allow_unplanned_traits` (Boolean) Enable to allow unplanned group traits.
+- `common_event_on_violations` (String) The common group event on violations.
+
+
+<a id="nestedatt--schema_settings--identify"></a>
+### Nested Schema for `schema_settings.identify`
+
+Read-Only:
+
+- `allow_traits_on_violations` (Boolean) Enable to allow identify traits on violations.
+- `allow_unplanned_traits` (Boolean) Enable to allow unplanned identify traits.
+- `common_event_on_violations` (String) The common identify event on violations.
+
+
+<a id="nestedatt--schema_settings--track"></a>
+### Nested Schema for `schema_settings.track`
+
+Read-Only:
+
+- `allow_event_on_violations` (Boolean) Allow track event on violations.
+- `allow_properties_on_violations` (Boolean) Enable to allow track properties on violations.
+- `allow_unplanned_event_properties` (Boolean) Enable to allow unplanned track event properties.
+- `allow_unplanned_events` (Boolean) Enable to allow unplanned track events.
+- `common_event_on_violations` (String) The common track event on violations.

docs/data-sources/user.md

@@ -54,6 +54,5 @@ Read-Only:
 
 Read-Only:
 
-- `description` (String) An optional description of the purpose of this label.
 - `key` (String) The key that represents the name of this label.
 - `value` (String) The value associated with the key of this label.

docs/resources/source.md

@@ -31,6 +31,44 @@ resource "segment_source" "my_source" {
     },
   ]
 }
+
+resource "segment_source" "my_source_with_schema_settings" {
+  slug    = "my_source_slug"
+  name    = "My Source"
+  enabled = true
+  metadata = {
+    id = "abc123"
+  }
+  settings = jsonencode({
+    "token" : "xyz321",
+  })
+  labels = [
+    {
+      key   = "env"
+      value = "dev"
+    },
+  ]
+  schema_settings = {
+    forwarding_blocked_events_to = segment_source.my_source.id
+    track = {
+      allow_unplanned_events           = true
+      allow_unplanned_event_properties = true
+      allow_event_on_violations        = false
+      allow_properties_on_violations   = true
+      common_event_on_violations       = "ALLOW"
+    }
+    identify = {
+      allow_traits_on_violations = false
+      allow_unplanned_traits     = false
+      common_event_on_violations = "ALLOW"
+    }
+    group = {
+      allow_traits_on_violations = true
+      allow_unplanned_traits     = true
+      common_event_on_violations = "ALLOW"
+    }
+  }
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -47,6 +85,7 @@ resource "segment_source" "my_source" {
 
 - `labels` (Attributes Set) A list of labels applied to the Source. (see [below for nested schema](#nestedatt--labels))
 - `name` (String) The name of the Source.
+- `schema_settings` (Attributes) The schema settings associated with the Source. Upon import, this field will be empty even if the settings have already been configured due to Terraform limitations, but will be populated on the first apply. Fields not present in the config will not be managed by Terraform. (see [below for nested schema](#nestedatt--schema_settings))
 
 ### Read-Only
 
@@ -103,6 +142,45 @@ Required:
 - `key` (String) The key that represents the name of this label.
 - `value` (String) The value associated with the key of this label.
 
-Read-Only:
 
-- `description` (String) An optional description of the purpose of this label.
+<a id="nestedatt--schema_settings"></a>
+### Nested Schema for `schema_settings`
+
+Optional:
+
+- `forwarding_blocked_events_to` (String) Source id to forward blocked events to.
+- `forwarding_violations_to` (String) Source id to forward violations to.
+- `group` (Attributes) Group settings. (see [below for nested schema](#nestedatt--schema_settings--group))
+- `identify` (Attributes) Identify settings. (see [below for nested schema](#nestedatt--schema_settings--identify))
+- `track` (Attributes) Track settings. (see [below for nested schema](#nestedatt--schema_settings--track))
+
+<a id="nestedatt--schema_settings--group"></a>
+### Nested Schema for `schema_settings.group`
+
+Optional:
+
+- `allow_traits_on_violations` (Boolean) Enable to allow group traits on violations.
+- `allow_unplanned_traits` (Boolean) Enable to allow unplanned group traits.
+- `common_event_on_violations` (String) The common group event on violations.
+
+
+<a id="nestedatt--schema_settings--identify"></a>
+### Nested Schema for `schema_settings.identify`
+
+Optional:
+
+- `allow_traits_on_violations` (Boolean) Enable to allow identify traits on violations.
+- `allow_unplanned_traits` (Boolean) Enable to allow unplanned identify traits.
+- `common_event_on_violations` (String) The common identify event on violations.
+
+
+<a id="nestedatt--schema_settings--track"></a>
+### Nested Schema for `schema_settings.track`
+
+Optional:
+
+- `allow_event_on_violations` (Boolean) Allow track event on violations.
+- `allow_properties_on_violations` (Boolean) Enable to allow track properties on violations.
+- `allow_unplanned_event_properties` (Boolean) Enable to allow unplanned track event properties.
+- `allow_unplanned_events` (Boolean) Enable to allow unplanned track events.
+- `common_event_on_violations` (String) The common track event on violations.

docs/resources/user.md

@@ -77,7 +77,3 @@ Required:
 
 - `key` (String) The key that represents the name of this label.
 - `value` (String) The value associated with the key of this label.
-
-Read-Only:
-
-- `description` (String) An optional description of the purpose of this label.

docs/resources/user_group.md

@@ -84,7 +84,3 @@ Required:
 
 - `key` (String) The key that represents the name of this label.
 - `value` (String) The value associated with the key of this label.
-
-Read-Only:
-
-- `description` (String) An optional description of the purpose of this label.

examples/resources/segment_source/resource.tf

@@ -16,3 +16,41 @@ resource "segment_source" "my_source" {
     },
   ]
 }
+
+resource "segment_source" "my_source_with_schema_settings" {
+  slug    = "my_source_slug"
+  name    = "My Source"
+  enabled = true
+  metadata = {
+    id = "abc123"
+  }
+  settings = jsonencode({
+    "token" : "xyz321",
+  })
+  labels = [
+    {
+      key   = "env"
+      value = "dev"
+    },
+  ]
+  schema_settings = {
+    forwarding_blocked_events_to = segment_source.my_source.id
+    track = {
+      allow_unplanned_events           = true
+      allow_unplanned_event_properties = true
+      allow_event_on_violations        = false
+      allow_properties_on_violations   = true
+      common_event_on_violations       = "ALLOW"
+    }
+    identify = {
+      allow_traits_on_violations = false
+      allow_unplanned_traits     = false
+      common_event_on_violations = "ALLOW"
+    }
+    group = {
+      allow_traits_on_violations = true
+      allow_unplanned_traits     = true
+      common_event_on_violations = "ALLOW"
+    }
+  }
+}

internal/provider/function_resource.go

@@ -198,6 +198,11 @@ func (r *functionResource) Read(ctx context.Context, req resource.ReadRequest, r
 	function := response.Data.GetFunction()
 	state.Fill(function)
 
+	// Destination functions append workspace name to display name causing inconsistency
+	if state.ResourceType.ValueString() == "DESTINATION" || state.ResourceType.ValueString() == "INSERT_DESTINATION" {
+		state.DisplayName = previousState.DisplayName
+	}
+
 	diags = resp.State.Set(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
@@ -249,6 +254,11 @@ func (r *functionResource) Update(ctx context.Context, req resource.UpdateReques
 
 	state.Fill(api.Function(function))
 
+	// Destination functions append workspace name to display name causing inconsistency
+	if state.ResourceType.ValueString() == "DESTINATION" || state.ResourceType.ValueString() == "INSERT_DESTINATION" {
+		state.DisplayName = plan.DisplayName
+	}
+
 	diags = resp.State.Set(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {

internal/provider/label_resource.go

@@ -84,7 +84,7 @@ func (r *labelResource) Schema(_ context.Context, _ resource.SchemaRequest, resp
 
 func (r *labelResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
 	// Retrieve values from plan
-	var plan models.LabelState
+	var plan models.LabelResourceState
 	diags := req.Plan.Get(ctx, &plan)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
@@ -115,7 +115,7 @@ func (r *labelResource) Create(ctx context.Context, req resource.CreateRequest,
 	}
 
 	outLabel := out.Data.Label
-	var state models.LabelState
+	var state models.LabelResourceState
 	state.Fill(api.LabelV1(outLabel))
 
 	// Set state to fully populated data
@@ -127,7 +127,7 @@ func (r *labelResource) Create(ctx context.Context, req resource.CreateRequest,
 }
 
 func (r *labelResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
-	var state models.LabelState
+	var state models.LabelResourceState
 	diags := req.State.Get(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
@@ -189,7 +189,7 @@ func (r *labelResource) Update(context.Context, resource.UpdateRequest, *resourc
 
 func (r *labelResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
 	// Retrieve values from state
-	var state models.LabelState
+	var state models.LabelResourceState
 	diags := req.State.Get(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {

internal/provider/models/destination_metadata.go

@@ -312,7 +312,7 @@ func (d *DestinationMetadataState) getLogosDestinationMetadata(logos api.Logos)
 }
 
 func getOptions(options []api.IntegrationOptionBeta) ([]IntegrationOptionState, error) {
-	var integrationOptions []IntegrationOptionState
+	integrationOptions := []IntegrationOptionState{}
 
 	for _, opt := range options {
 		integrationOption := IntegrationOptionState{

internal/provider/models/label.go

@@ -9,6 +9,11 @@ import (
 )
 
 type LabelState struct {
+	Key   types.String `tfsdk:"key"`
+	Value types.String `tfsdk:"value"`
+}
+
+type LabelResourceState struct {
 	Key         types.String `tfsdk:"key"`
 	Value       types.String `tfsdk:"value"`
 	Description types.String `tfsdk:"description"`
@@ -24,6 +29,18 @@ func (l *LabelState) ToAPIValue() api.AllowedLabelBeta {
 func (l *LabelState) Fill(label api.LabelV1) {
 	l.Key = types.StringValue(label.Key)
 	l.Value = types.StringValue(label.Value)
+}
+
+func (l *LabelResourceState) ToAPIValue() api.AllowedLabelBeta {
+	return api.AllowedLabelBeta{
+		Key:   l.Key.ValueString(),
+		Value: l.Value.ValueString(),
+	}
+}
+
+func (l *LabelResourceState) Fill(label api.LabelV1) {
+	l.Key = types.StringValue(label.Key)
+	l.Value = types.StringValue(label.Value)
 	l.Description = types.StringPointerValue(label.Description)
 }