Merge pull request #268 from port-labs/add_pathFilter_tf_support

Add path filter tf support

Author: razsamuel

docs/resources/port_aggregation_properties.md

@@ -606,6 +606,7 @@ Optional:
 
 - `description` (String) The description of the aggregation property
 - `icon` (String) The icon of the aggregation property
+- `path_filter` (Attributes List) Path filter to filter entities based on relation path (see [below for nested schema](#nestedatt--properties--path_filter))
 - `query` (String) Query to filter the target entities
 - `title` (String) The title of the aggregation property
 
@@ -645,3 +646,16 @@ Optional:
 
 - `average_of` (String) The time periods to calculate the average of, e.g. hour, day, week, month
 - `measure_time_by` (String) The property name on which to calculate the the time periods, e.g. $createdAt, $updated_at or any other date property
+
+
+
+<a id="nestedatt--properties--path_filter"></a>
+### Nested Schema for `properties.path_filter`
+
+Required:
+
+- `path` (List of String) The path array of relations to filter by
+
+Optional:
+
+- `from_blueprint` (String) The blueprint to start the path from. Should be the target blueprint or undefined to start from the source blueprint

examples/resources/port_aggregation_property/main.tf

@@ -42,6 +42,12 @@ resource "port_aggregation_properties" "parent_aggregation_properties" {
       method = {
         count_entities = true
       }
+      path_filter = [
+        {
+          from_blueprint = port_blueprint.child_blueprint.identifier
+          path          = ["parent"]
+        }
+      ]
     }
   }
 }

internal/cli/models.go

@@ -146,12 +146,18 @@ type (
 	}
 
 	BlueprintAggregationProperty struct {
-		Title           *string           `json:"title,omitempty"`
-		Description     *string           `json:"description,omitempty"`
-		Icon            *string           `json:"icon,omitempty"`
-		Target          string            `json:"target,omitempty"`
-		CalculationSpec map[string]string `json:"calculationSpec,omitempty"`
-		Query           any               `json:"query,omitempty"`
+		Title           *string                         `json:"title,omitempty"`
+		Description     *string                         `json:"description,omitempty"`
+		Icon            *string                         `json:"icon,omitempty"`
+		Target          string                          `json:"target,omitempty"`
+		CalculationSpec map[string]string               `json:"calculationSpec,omitempty"`
+		Query           any                             `json:"query,omitempty"`
+		PathFilter      []AggregationPropertyPathFilter `json:"pathFilter,omitempty"`
+	}
+
+	AggregationPropertyPathFilter struct {
+		FromBlueprint string   `json:"fromBlueprint,omitempty"`
+		Path          []string `json:"path"`
 	}
 
 	BlueprintMirrorProperty struct {

port/aggregation-properties/model.go

@@ -9,12 +9,13 @@ type AggregationPropertiesModel struct {
 }
 
 type AggregationPropertyModel struct {
-	Title                     types.String             `tfsdk:"title"`
-	Icon                      types.String             `tfsdk:"icon"`
-	Description               types.String             `tfsdk:"description"`
-	TargetBlueprintIdentifier types.String             `tfsdk:"target_blueprint_identifier"`
-	Method                    *AggregationMethodsModel `tfsdk:"method"`
-	Query                     types.String             `tfsdk:"query"`
+	Title                     types.String                         `tfsdk:"title"`
+	Icon                      types.String                         `tfsdk:"icon"`
+	Description               types.String                         `tfsdk:"description"`
+	TargetBlueprintIdentifier types.String                         `tfsdk:"target_blueprint_identifier"`
+	Method                    *AggregationMethodsModel             `tfsdk:"method"`
+	Query                     types.String                         `tfsdk:"query"`
+	PathFilter                []AggregationPropertyPathFilterModel `tfsdk:"path_filter"`
 }
 
 type AggregationMethodsModel struct {
@@ -39,3 +40,8 @@ type AggregateByPropertyModel struct {
 	Func     types.String `tfsdk:"func"`
 	Property types.String `tfsdk:"property"`
 }
+
+type AggregationPropertyPathFilterModel struct {
+	FromBlueprint types.String `tfsdk:"from_blueprint"`
+	Path          types.List   `tfsdk:"path"`
+}

port/aggregation-properties/readStateToPortBody.go

@@ -1,6 +1,7 @@
 package aggregation_properties
 
 import (
+	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/port-labs/terraform-provider-port-labs/v2/internal/cli"
 	"github.com/port-labs/terraform-provider-port-labs/v2/internal/utils"
 )
@@ -61,6 +62,26 @@ func aggregationPropertiesToBody(state *AggregationPropertiesModel) (*map[string
 			newAggregationProperty.Query = *query
 		}
 
+		if len(aggregationProperty.PathFilter) > 0 {
+			pathFilter := make([]cli.AggregationPropertyPathFilter, len(aggregationProperty.PathFilter))
+			for i, pf := range aggregationProperty.PathFilter {
+				pathFilter[i] = cli.AggregationPropertyPathFilter{}
+
+				if !pf.FromBlueprint.IsNull() {
+					pathFilter[i].FromBlueprint = pf.FromBlueprint.ValueString()
+				}
+
+				var pathStrings []string
+				for _, pathElement := range pf.Path.Elements() {
+					if pathStr, ok := pathElement.(types.String); ok {
+						pathStrings = append(pathStrings, pathStr.ValueString())
+					}
+				}
+				pathFilter[i].Path = pathStrings
+			}
+			newAggregationProperty.PathFilter = pathFilter
+		}
+
 		aggregationProperties[aggregationPropertyIdentifier] = newAggregationProperty
 	}
 

port/aggregation-properties/refreshAggregationPropertyToState.go

@@ -1,6 +1,7 @@
 package aggregation_properties
 
 import (
+	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/port-labs/terraform-provider-port-labs/v2/internal/cli"
 	"github.com/port-labs/terraform-provider-port-labs/v2/internal/utils"
@@ -20,6 +21,7 @@ func (r *AggregationPropertiesResource) refreshAggregationPropertiesState(state
 			TargetBlueprintIdentifier: types.StringValue(aggregationProperty.Target),
 			Method:                    nil,
 			Query:                     types.StringPointerValue(nil),
+			PathFilter:                nil,
 		}
 
 		query, err := utils.GoObjectToTerraformString(aggregationProperty.Query, r.portClient.JSONEscapeHTML)
@@ -28,6 +30,27 @@ func (r *AggregationPropertiesResource) refreshAggregationPropertiesState(state
 		}
 		state.Properties[aggregationPropertyIdentifier].Query = query
 
+		if len(aggregationProperty.PathFilter) > 0 {
+			pathFilter := make([]AggregationPropertyPathFilterModel, len(aggregationProperty.PathFilter))
+			for i, pf := range aggregationProperty.PathFilter {
+				pathFilter[i] = AggregationPropertyPathFilterModel{}
+
+				if pf.FromBlueprint != "" {
+					pathFilter[i].FromBlueprint = types.StringValue(pf.FromBlueprint)
+				} else {
+					pathFilter[i].FromBlueprint = types.StringNull()
+				}
+
+				pathElements := make([]attr.Value, len(pf.Path))
+				for j, pathStr := range pf.Path {
+					pathElements[j] = types.StringValue(pathStr)
+				}
+				pathList, _ := types.ListValue(types.StringType, pathElements)
+				pathFilter[i].Path = pathList
+			}
+			state.Properties[aggregationPropertyIdentifier].PathFilter = pathFilter
+		}
+
 		if aggregationProperty.CalculationSpec != nil {
 			if calculationBy, ok := aggregationProperty.CalculationSpec["calculationBy"]; ok {
 				if calculationBy == "entities" {