Fix pointer handling issues across codebase for better Go idioms

.changes/unreleased/fixed_pointer_handling.yaml

@@ -0,0 +1,4 @@
+kind: fixed
+body: Fix pointer handling issues across codebase for better Go idioms
+custom:
+  Issue: 804

internal/customtypes/uuid.go

@@ -8,24 +8,28 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 )
 
+// NewUUIDNull returns a UUID representing a null value.
 func NewUUIDNull() UUID {
 	return UUID{
 		StringValue: basetypes.NewStringNull(),
 	}
 }
 
+// NewUUIDUnknown returns a UUID representing an unknown value.
 func NewUUIDUnknown() UUID {
 	return UUID{
 		StringValue: basetypes.NewStringUnknown(),
 	}
 }
 
+// NewUUIDValue returns a UUID initialized with the given string value.
 func NewUUIDValue(value string) UUID {
 	return UUID{
 		StringValue: basetypes.NewStringValue(value),
 	}
 }
 
+// NewUUIDPointerValue returns a UUID from a string pointer, or null if the pointer is nil.
 func NewUUIDPointerValue(value *string) UUID {
 	if value == nil {
 		return NewUUIDNull()
@@ -34,10 +38,12 @@ func NewUUIDPointerValue(value *string) UUID {
 	return NewUUIDValue(*value)
 }
 
+// NewUUIDValueMust returns a UUID from a string value and validates it as a UUID.
 func NewUUIDValueMust(value string) (UUID, diag.Diagnostics) {
 	return NewUUIDValue(value).ValueUUID()
 }
 
+// NewUUIDPointerValueMust returns a UUID from a string pointer and validates it as a UUID.
 func NewUUIDPointerValueMust(value *string) (UUID, diag.Diagnostics) {
 	return NewUUIDValue(*value).ValueUUID()
 }

internal/services/admin_management_application/api_admin_management_application.go

@@ -37,6 +37,7 @@ func (client *client) GetAdminApplication(ctx context.Context, clientId string)
 	var adminApp adminManagementApplicationDto
 	_, err := client.Api.Execute(ctx, nil, "GET", apiUrl.String(), nil, nil, []int{http.StatusOK}, &adminApp)
 
+	// Returning pointer to local variable is acceptable for small DTOs
 	return &adminApp, err
 }
 
@@ -53,6 +54,7 @@ func (client *client) RegisterAdminApplication(ctx context.Context, clientId str
 	var adminApp adminManagementApplicationDto
 	_, err := client.Api.Execute(ctx, nil, "PUT", apiUrl.String(), nil, nil, []int{http.StatusOK}, &adminApp)
 
+	// Returning pointer to local variable is acceptable for small DTOs
 	return &adminApp, err
 }
 

internal/services/analytics_data_export/api_analytics_data_exports.go

@@ -55,7 +55,7 @@ func (client *Client) GetGatewayCluster(ctx context.Context) (*GatewayClusterDto
 	return &gatewayCluster, nil
 }
 
-func (client *Client) GetAnalyticsDataExport(ctx context.Context) (*[]AnalyticsDataDto, error) {
+func (client *Client) GetAnalyticsDataExport(ctx context.Context) ([]AnalyticsDataDto, error) {
 	// Get the gateway cluster
 	gatewayCluster, err := client.GetGatewayCluster(ctx)
 	if err != nil {
@@ -83,7 +83,7 @@ func (client *Client) GetAnalyticsDataExport(ctx context.Context) (*[]AnalyticsD
 		return nil, fmt.Errorf("failed to get analytics data export: %w", err)
 	}
 
-	return &adr.Value, nil
+	return adr.Value, nil
 }
 
 func getAnalyticsUrlMap() map[string]string {

internal/services/analytics_data_export/datasource_analytics_data_exports.go

@@ -189,18 +189,10 @@ func (d *AnalyticsExportDataSource) Read(ctx context.Context, req datasource.Rea
 		)
 		return
 	}
-	if analyticsDataExport == nil {
-		resp.Diagnostics.AddError(
-			"Analytics data export not found",
-			"Unable to find analytics data export with the specified ID",
-		)
-		return
-	}
-
 	// Map the response to the model
 	// Map each analytics data export item to a model
-	exports := make([]AnalyticsDataModel, 0, len(*analyticsDataExport))
-	for _, export := range *analyticsDataExport {
+	exports := make([]AnalyticsDataModel, 0, len(analyticsDataExport))
+	for _, export := range analyticsDataExport {
 		if model := convertDtoToModel(&export); model != nil {
 			exports = append(exports, *model)
 		}

internal/services/connection/resource_connection.go

@@ -143,7 +143,7 @@ func (r *Resource) Configure(ctx context.Context, req resource.ConfigureRequest,
 func (r *Resource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
 	ctx, exitContext := helpers.EnterRequestContext(ctx, r.TypeInfo, req)
 	defer exitContext()
-	var plan *ResourceModel
+	var plan ResourceModel
 
 	resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
 
@@ -245,11 +245,11 @@ func (r *Resource) Update(ctx context.Context, req resource.UpdateRequest, resp
 	ctx, exitContext := helpers.EnterRequestContext(ctx, r.TypeInfo, req)
 	defer exitContext()
 
-	var plan *ResourceModel
+	var plan ResourceModel
 
 	resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
 
-	var state *ResourceModel
+	var state ResourceModel
 	resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
 	if resp.Diagnostics.HasError() {
 		return

internal/services/data_record/resource_data_record.go

@@ -163,7 +163,7 @@ func (r *DataRecordResource) Create(ctx context.Context, req resource.CreateRequ
 func (r *DataRecordResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
 	ctx, exitContext := helpers.EnterRequestContext(ctx, r.TypeInfo, req)
 	defer exitContext()
-	var state *DataRecordResourceModel
+	var state DataRecordResourceModel
 
 	resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
 
@@ -199,11 +199,11 @@ func (r *DataRecordResource) Update(ctx context.Context, req resource.UpdateRequ
 	ctx, exitContext := helpers.EnterRequestContext(ctx, r.TypeInfo, req)
 	defer exitContext()
 
-	var plan *DataRecordResourceModel
+	var plan DataRecordResourceModel
 
 	resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
 
-	var state *DataRecordResourceModel
+	var state DataRecordResourceModel
 	resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
 
 	if resp.Diagnostics.HasError() {

internal/services/environment/datasource_environments.go

@@ -123,7 +123,7 @@ func (d *EnvironmentsDataSource) Schema(ctx context.Context, req datasource.Sche
 							MarkdownDescription: "Gives you the ability to create environments that are updated first. This allows you to experience and validate scenarios that are important to you before any updates reach your business-critical applications. See [more](https://learn.microsoft.com/en-us/power-platform/admin/early-release).",
 							Computed:            true,
 						},
-						"billing_policy_id": &schema.StringAttribute{
+						"billing_policy_id": schema.StringAttribute{
 							MarkdownDescription: "Billing policy id (guid) for pay-as-you-go environments using Azure subscription billing",
 							Computed:            true,
 						},
@@ -202,7 +202,7 @@ func (d *EnvironmentsDataSource) Schema(ctx context.Context, req datasource.Sche
 									MarkdownDescription: "URL of the linked D365 app",
 									Computed:            true,
 								},
-								"currency_code": &schema.StringAttribute{
+								"currency_code": schema.StringAttribute{
 									MarkdownDescription: "Currency name (EUR, USE, GBP etc.)",
 									Computed:            true,
 								},

internal/services/solution_checker_rules/client.go

@@ -14,20 +14,20 @@ import (
 	"github.com/microsoft/terraform-provider-power-platform/internal/services/environment"
 )
 
-type client struct {
+type Client struct {
 	Api               *api.Client
 	environmentClient environment.Client
 }
 
-func newSolutionCheckerRulesClient(apiClient *api.Client) client {
-	return client{
+func NewSolutionCheckerRulesClient(apiClient *api.Client) *Client {
+	return &Client{
 		Api:               apiClient,
 		environmentClient: environment.NewEnvironmentClient(apiClient),
 	}
 }
 
 // Data transfer objects.
-type ruleDto struct {
+type RuleDto struct {
 	Code            string `json:"code"`
 	Description     string `json:"description"`
 	Summary         string `json:"summary"`
@@ -39,7 +39,7 @@ type ruleDto struct {
 	Severity        int    `json:"severity"`
 }
 
-func (c *client) GetSolutionCheckerRules(ctx context.Context, environmentId string) ([]ruleDto, error) {
+func (c *Client) GetSolutionCheckerRules(ctx context.Context, environmentId string) ([]RuleDto, error) {
 	env, err := c.environmentClient.GetEnvironment(ctx, environmentId)
 	if err != nil {
 		return nil, fmt.Errorf("failed to get environment details for %s: %w", environmentId, err)
@@ -68,7 +68,7 @@ func (c *client) GetSolutionCheckerRules(ctx context.Context, environmentId stri
 	queryParams.Add("api-version", "2.0")
 	rulesUrl.RawQuery = queryParams.Encode()
 
-	var rules []ruleDto
+	var rules []RuleDto
 	_, err = c.Api.Execute(ctx, nil, "GET", rulesUrl.String(), nil, nil, []int{http.StatusOK}, &rules)
 	if err != nil {
 		return nil, fmt.Errorf("failed to get solution checker rules: %w", err)

internal/services/solution_checker_rules/datasource_solution_checker_rules.go

@@ -118,7 +118,7 @@ func (d *DataSource) Configure(ctx context.Context, req datasource.ConfigureRequ
 		)
 		return
 	}
-	d.SolutionCheckerRulesClient = newSolutionCheckerRulesClient(client.Api)
+	d.SolutionCheckerRulesClient = NewSolutionCheckerRulesClient(client.Api)
 }
 
 func (d *DataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {

internal/services/solution_checker_rules/models.go

@@ -11,7 +11,7 @@ import (
 
 type DataSource struct {
 	helpers.TypeInfo
-	SolutionCheckerRulesClient client
+	SolutionCheckerRulesClient *Client
 }
 
 type DataSourceModel struct {
@@ -34,7 +34,7 @@ type RuleModel struct {
 }
 
 // Helper function to convert from DTO to Model.
-func convertFromRuleDto(rule ruleDto) RuleModel {
+func convertFromRuleDto(rule RuleDto) RuleModel {
 	return RuleModel{
 		Code:                       types.StringValue(rule.Code),
 		Description:                types.StringValue(rule.Description),

internal/services/tenant_settings/dto.go

@@ -15,6 +15,14 @@ import (
 	"github.com/microsoft/terraform-provider-power-platform/internal/customtypes"
 )
 
+// Helper functions to reduce boilerplate for null/unknown checks.
+func getBoolPointer(v basetypes.BoolValue) *bool {
+	if !v.IsNull() && !v.IsUnknown() {
+		return v.ValueBoolPointer()
+	}
+	return nil
+}
+
 type tenantDto struct {
 	TenantId                         string `json:"tenantId,omitempty"`
 	State                            string `json:"state,omitempty"`
@@ -133,33 +141,15 @@ type tenantSettingsDto struct {
 func convertFromTenantSettingsModel(ctx context.Context, tenantSettings TenantSettingsResourceModel) (tenantSettingsDto, error) {
 	tenantSettingsDto := tenantSettingsDto{}
 
-	if !tenantSettings.WalkMeOptOut.IsNull() && !tenantSettings.WalkMeOptOut.IsUnknown() {
-		tenantSettingsDto.WalkMeOptOut = tenantSettings.WalkMeOptOut.ValueBoolPointer()
-	}
-	if !tenantSettings.DisableNPSCommentsReachout.IsNull() && !tenantSettings.DisableNPSCommentsReachout.IsUnknown() {
-		tenantSettingsDto.DisableNPSCommentsReachout = tenantSettings.DisableNPSCommentsReachout.ValueBoolPointer()
-	}
-	if !tenantSettings.DisableNewsletterSendout.IsNull() && !tenantSettings.DisableNewsletterSendout.IsUnknown() {
-		tenantSettingsDto.DisableNewsletterSendout = tenantSettings.DisableNewsletterSendout.ValueBoolPointer()
-	}
-	if !tenantSettings.DisableEnvironmentCreationByNonAdminUsers.IsNull() && !tenantSettings.DisableEnvironmentCreationByNonAdminUsers.IsUnknown() {
-		tenantSettingsDto.DisableEnvironmentCreationByNonAdminUsers = tenantSettings.DisableEnvironmentCreationByNonAdminUsers.ValueBoolPointer()
-	}
-	if !tenantSettings.DisablePortalsCreationByNonAdminUsers.IsNull() && !tenantSettings.DisablePortalsCreationByNonAdminUsers.IsUnknown() {
-		tenantSettingsDto.DisablePortalsCreationByNonAdminUsers = tenantSettings.DisablePortalsCreationByNonAdminUsers.ValueBoolPointer()
-	}
-	if !tenantSettings.DisableSurveyFeedback.IsNull() && !tenantSettings.DisableSurveyFeedback.IsUnknown() {
-		tenantSettingsDto.DisableSurveyFeedback = tenantSettings.DisableSurveyFeedback.ValueBoolPointer()
-	}
-	if !tenantSettings.DisableTrialEnvironmentCreationByNonAdminUsers.IsNull() && !tenantSettings.DisableTrialEnvironmentCreationByNonAdminUsers.IsUnknown() {
-		tenantSettingsDto.DisableTrialEnvironmentCreationByNonAdminUsers = tenantSettings.DisableTrialEnvironmentCreationByNonAdminUsers.ValueBoolPointer()
-	}
-	if !tenantSettings.DisableCapacityAllocationByEnvironmentAdmins.IsNull() && !tenantSettings.DisableCapacityAllocationByEnvironmentAdmins.IsUnknown() {
-		tenantSettingsDto.DisableCapacityAllocationByEnvironmentAdmins = tenantSettings.DisableCapacityAllocationByEnvironmentAdmins.ValueBoolPointer()
-	}
-	if !tenantSettings.DisableSupportTicketsVisibleByAllUsers.IsNull() && !tenantSettings.DisableSupportTicketsVisibleByAllUsers.IsUnknown() {
-		tenantSettingsDto.DisableSupportTicketsVisibleByAllUsers = tenantSettings.DisableSupportTicketsVisibleByAllUsers.ValueBoolPointer()
-	}
+	tenantSettingsDto.WalkMeOptOut = getBoolPointer(tenantSettings.WalkMeOptOut)
+	tenantSettingsDto.DisableNPSCommentsReachout = getBoolPointer(tenantSettings.DisableNPSCommentsReachout)
+	tenantSettingsDto.DisableNewsletterSendout = getBoolPointer(tenantSettings.DisableNewsletterSendout)
+	tenantSettingsDto.DisableEnvironmentCreationByNonAdminUsers = getBoolPointer(tenantSettings.DisableEnvironmentCreationByNonAdminUsers)
+	tenantSettingsDto.DisablePortalsCreationByNonAdminUsers = getBoolPointer(tenantSettings.DisablePortalsCreationByNonAdminUsers)
+	tenantSettingsDto.DisableSurveyFeedback = getBoolPointer(tenantSettings.DisableSurveyFeedback)
+	tenantSettingsDto.DisableTrialEnvironmentCreationByNonAdminUsers = getBoolPointer(tenantSettings.DisableTrialEnvironmentCreationByNonAdminUsers)
+	tenantSettingsDto.DisableCapacityAllocationByEnvironmentAdmins = getBoolPointer(tenantSettings.DisableCapacityAllocationByEnvironmentAdmins)
+	tenantSettingsDto.DisableSupportTicketsVisibleByAllUsers = getBoolPointer(tenantSettings.DisableSupportTicketsVisibleByAllUsers)
 
 	if !tenantSettings.PowerPlatform.IsNull() && !tenantSettings.PowerPlatform.IsUnknown() {
 		powerPlatformAttributes := tenantSettings.PowerPlatform.Attributes()