azurerm_app_configuration_feature - fix feature flags are not valid

[ksmets]

Community Note

• Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
• Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

Adding a targeting filter, after first creating a feature flag without one, results in a feature flag that is not valid.

To reproduce. First create a feature flag without targeting filter, e.g.

resource "azurerm_app_configuration_feature" "alpha" {
  configuration_store_id = azurerm_app_configuration.example.id
  name                   = "alpha"
  enabled                = true
}

Then, re-apply with a targeting filter, e.g.

resource "azurerm_app_configuration_feature" "alpha" {
  configuration_store_id = azurerm_app_configuration.example.id
  name                   = "alpha"
  enabled                = true

  targeting_filter {
    default_rollout_percentage = 0

    users = [
      "[email protected]",
    ]
  }
}

azurerm_app_configuration_feature.alpha: Modifying... [id=https://*******.azconfig.io/kv/.appconfig.featureflag%alpha?label=]
╷
│ Error: while unmarshalling underlying key's value: unknown type ""
│
│   with azurerm_app_configuration_feature.alpha,
│   on main.tf line ***, in resource "azurerm_app_configuration_feature" "alpha":
│  ***: resource "azurerm_app_configuration_feature" "alpha" {
│
│ while unmarshalling underlying key's value: unknown type ""

This results in an invalid feature flag as indicated in the feature manager:

{
	"id": "alpha",
	"description": "",
	"enabled": true,
	"conditions": {
		"client_filters": [
			{
				"name": "",
				"parameters": {
					"Value": 0
				}
			},
			{
				"name": "Microsoft.Targeting",
				"parameters": {
					"Audience": {
						"DefaultRolloutPercentage": 0,
						"Users": [
							"[email protected]"
						],
						"Groups": []
					}
				}
			}
		]
	}
}

The fix is to easy: to rule out whether the default percentageFilter := PercentageFeatureFilter{} is assigned when iterating fv.Conditions.ClientFilters.Filters, we change the else if-clause to check percentageFilter.Name != "".

PR Checklist

• I have followed the guidelines in our Contributing Documentation.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
• I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
• I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
  For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

• I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
• I have written new tests for my resource or datasource changes & updated any relevent documentation.
• I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
• (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

• My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

• azurerm_app_configuration_feature - fix feature flags are not valid

This is a (please select all that apply):

• Bug Fix
• New Feature (ie adding a service, resource, or data source)
• Enhancement
• Breaking Change

Related Issue(s)

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

[stephybun]

Thanks for this @ksmets. It should be possible to add an acceptance test that follows the reproduction steps you've outlined in the PR description to validate this change. Would you mind adding that?

[stephybun]

Thanks for adding the test, looks like a required argument is missing here though:

------- Stdout: -------
=== RUN   TestAccAppConfigurationFeature_basicAddTargetingFilter
=== PAUSE TestAccAppConfigurationFeature_basicAddTargetingFilter
=== CONT  TestAccAppConfigurationFeature_basicAddTargetingFilter
    testcase.go:113: Step 3/4 error: Error running pre-apply refresh: exit status 1
        Error: Missing required argument
          on terraform_plugin_test.tf line 59, in resource "azurerm_app_configuration_feature" "test":
          59:   targeting_filter {
        The argument "default_rollout_percentage" is required, but no definition was
        found.

[stephybun]

Thanks @ksmets LGTM 👍

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.