fix: force refresh when service version is reverted outside of Terraform

docs/resources/service_compute.md

@@ -111,6 +111,7 @@ $ terraform import fastly_service_compute.demo xxxxxxxxxxxxxxxxxxxx@2
 
 - `active_version` (Number) The currently active version of your Fastly Service
 - `cloned_version` (Number) The latest cloned version by the provider
+- `force_refresh` (Boolean) Used internally by the provider to temporarily indicate if all resources should call their associated API to update the local state. This is for scenarios where the service version has been reverted outside of Terraform (e.g. via the Fastly UI) and the provider needs to resync the state for a different active version (this is only if `activate` is `true`).
 - `id` (String) The ID of this resource.
 - `imported` (Boolean) Used internally by the provider to temporarily indicate if the service is being imported, and is reset to false once the import is finished
 

docs/resources/service_vcl.md

@@ -294,6 +294,7 @@ $ terraform import fastly_service_vcl.demo xxxxxxxxxxxxxxxxxxxx@2
 
 - `active_version` (Number) The currently active version of your Fastly Service
 - `cloned_version` (Number) The latest cloned version by the provider
+- `force_refresh` (Boolean) Used internally by the provider to temporarily indicate if all resources should call their associated API to update the local state. This is for scenarios where the service version has been reverted outside of Terraform (e.g. via the Fastly UI) and the provider needs to resync the state for a different active version (this is only if `activate` is `true`).
 - `id` (String) The ID of this resource.
 - `imported` (Boolean) Used internally by the provider to temporarily indicate if the service is being imported, and is reset to false once the import is finished
 

fastly/base_fastly_service.go

@@ -116,6 +116,11 @@ func resourceService(serviceDef ServiceDefinition) *schema.Resource {
 				Description:   "Services that are active cannot be destroyed. In order to destroy the Service, set `force_destroy` to `true`. Default `false`",
 				ConflictsWith: []string{"reuse"},
 			},
+			"force_refresh": {
+				Type:        schema.TypeBool,
+				Computed:    true,
+				Description: "Used internally by the provider to temporarily indicate if all resources should call their associated API to update the local state. This is for scenarios where the service version has been reverted outside of Terraform (e.g. via the Fastly UI) and the provider needs to resync the state for a different active version (this is only if `activate` is `true`).",
+			},
 			"imported": {
 				Type:        schema.TypeBool,
 				Computed:    true,
@@ -452,6 +457,35 @@ func resourceServiceRead(ctx context.Context, d *schema.ResourceData, meta any,
 	if err != nil {
 		return diag.FromErr(err)
 	}
+
+	var activeVersionFromPriorState int
+	if i := d.Get("active_version"); i != nil {
+		activeVersionFromPriorState = i.(int)
+	}
+
+	var activate bool
+	if i := d.Get("activate"); i != nil {
+		activate = i.(bool)
+	}
+
+	// If the user has reverted a service version via the Fastly UI, then the
+	// active version of the service will no longer match the version being
+	// tracked in the state file. This means we can use this information to help
+	// force each nested service resource to call its API to update the state.
+	//
+	// REFERENCE:
+	// https://github.com/fastly/terraform-provider-fastly/issues/629
+	//
+	// NOTE: We only force a refresh if `activate = true` in config.
+	// This is because if the user has set it to false, then the expectation is
+	// for the version to drift and so there will be no active version to use.
+	if activeVersionFromPriorState != s.ActiveVersion.Number && activate {
+		err = d.Set("force_refresh", true)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+
 	err = d.Set("active_version", s.ActiveVersion.Number)
 	if err != nil {
 		return diag.FromErr(err)
@@ -528,13 +562,19 @@ func resourceServiceRead(ctx context.Context, d *schema.ResourceData, meta any,
 	}
 
 	// To ensure nested resources (e.g. backends, domains etc) don't continue to
-	// call the API to refresh the internal Terraform state, once an import is
-	// complete, we reset the 'imported' computed attribute to false.
+	// call the API to refresh the internal Terraform state, once an import or a
+	// forced refresh is complete, we reset both the 'imported' and
+	// 'force_refresh' computed attributes back to false.
 	err = d.Set("imported", false)
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
+	err = d.Set("force_refresh", false)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
 	return diags
 }
 

fastly/block_fastly_service_acl.go

@@ -75,7 +75,7 @@ func (h *ACLServiceAttributeHandler) Create(_ context.Context, d *schema.Resourc
 func (h *ACLServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, latestVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.Key()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing ACLs for (%s)", d.Id())
 		remoteState, err := conn.ListACLs(&gofastly.ListACLsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_backend.go

@@ -211,7 +211,7 @@ func (h *BackendServiceAttributeHandler) Create(_ context.Context, d *schema.Res
 func (h *BackendServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Backends for (%s)", d.Id())
 		remoteState, err := conn.ListBackends(&gofastly.ListBackendsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_cachesetting.go

@@ -90,7 +90,7 @@ func (h *CacheSettingServiceAttributeHandler) Create(_ context.Context, d *schem
 func (h *CacheSettingServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Cache Settings for (%s)", d.Id())
 		remoteState, err := conn.ListCacheSettings(&gofastly.ListCacheSettingsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_condition.go

@@ -89,7 +89,7 @@ func (h *ConditionServiceAttributeHandler) Create(_ context.Context, d *schema.R
 func (h *ConditionServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Conditions for (%s)", d.Id())
 		remoteState, err := conn.ListConditions(&gofastly.ListConditionsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_dictionary.go

@@ -85,7 +85,7 @@ func (h *DictionaryServiceAttributeHandler) Create(_ context.Context, d *schema.
 func (h *DictionaryServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Dictionaries for (%s)", d.Id())
 		remoteState, err := conn.ListDictionaries(&gofastly.ListDictionariesInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_director.go

@@ -140,7 +140,7 @@ func (h *DirectorServiceAttributeHandler) Create(_ context.Context, d *schema.Re
 func (h *DirectorServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Directors for (%s)", d.Id())
 		remoteState, err := conn.ListDirectors(&gofastly.ListDirectorsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_domain.go

@@ -76,7 +76,7 @@ func (h *DomainServiceAttributeHandler) Create(_ context.Context, d *schema.Reso
 func (h *DomainServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		// TODO: update go-fastly to support an ActiveVersion struct, which contains
 		// domain and backend info in the response. Here we do 2 additional queries
 		// to find out that info

fastly/block_fastly_service_dynamicsnippet.go

@@ -92,7 +92,7 @@ func (h *DynamicSnippetServiceAttributeHandler) Create(_ context.Context, d *sch
 func (h *DynamicSnippetServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing VCL Snippets for (%s)", d.Id())
 		remoteState, err := conn.ListSnippets(&gofastly.ListSnippetsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_gzip.go

@@ -94,7 +94,7 @@ func (h *GzipServiceAttributeHandler) Create(_ context.Context, d *schema.Resour
 func (h *GzipServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Gzips for (%s)", d.Id())
 		remoteState, err := conn.ListGzips(&gofastly.ListGzipsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_header.go

@@ -134,7 +134,7 @@ func (h *HeaderServiceAttributeHandler) Create(_ context.Context, d *schema.Reso
 func (h *HeaderServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Headers for (%s)", d.Id())
 		remoteState, err := conn.ListHeaders(&gofastly.ListHeadersInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_healthcheck.go

@@ -159,7 +159,7 @@ func (h *HealthCheckServiceAttributeHandler) Create(_ context.Context, d *schema
 func (h *HealthCheckServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Healthcheck for (%s)", d.Id())
 		remoteState, err := conn.ListHealthChecks(&gofastly.ListHealthChecksInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_bigquery.go

@@ -155,7 +155,7 @@ func (h *BigQueryLoggingServiceAttributeHandler) Create(_ context.Context, d *sc
 func (h *BigQueryLoggingServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing BigQuery for (%s)", d.Id())
 		remoteState, err := conn.ListBigQueries(&gofastly.ListBigQueriesInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_blobstorage.go

@@ -194,7 +194,7 @@ func (h *BlobStorageLoggingServiceAttributeHandler) Create(_ context.Context, d
 func (h *BlobStorageLoggingServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Blob Storages for (%s)", d.Id())
 		remoteState, err := conn.ListBlobStorages(&gofastly.ListBlobStoragesInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_cloudfiles.go

@@ -154,7 +154,7 @@ func (h *CloudfilesServiceAttributeHandler) Create(_ context.Context, d *schema.
 func (h *CloudfilesServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		// Refresh Cloud Files.
 		log.Printf("[DEBUG] Refreshing Cloud Files logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListCloudfiles(&gofastly.ListCloudfilesInput{

fastly/block_fastly_service_logging_datadog.go

@@ -99,7 +99,7 @@ func (h *DatadogServiceAttributeHandler) Create(_ context.Context, d *schema.Res
 func (h *DatadogServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Datadog logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListDatadog(&gofastly.ListDatadogInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_digitalocean.go

@@ -154,7 +154,7 @@ func (h *DigitalOceanServiceAttributeHandler) Create(_ context.Context, d *schem
 func (h *DigitalOceanServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing DigitalOcean Spaces logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListDigitalOceans(&gofastly.ListDigitalOceansInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_elasticsearch.go

@@ -150,7 +150,7 @@ func (h *ElasticSearchServiceAttributeHandler) Create(_ context.Context, d *sche
 func (h *ElasticSearchServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Elasticsearch logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListElasticsearch(&gofastly.ListElasticsearchInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_ftp.go

@@ -155,7 +155,7 @@ func (h *FTPServiceAttributeHandler) Create(_ context.Context, d *schema.Resourc
 func (h *FTPServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing FTP logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListFTPs(&gofastly.ListFTPsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_gcs.go

@@ -191,7 +191,7 @@ func (h *GCSLoggingServiceAttributeHandler) Create(_ context.Context, d *schema.
 func (h *GCSLoggingServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing GCS for (%s)", d.Id())
 		remoteState, err := conn.ListGCSs(&gofastly.ListGCSsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_googlepubsub.go

@@ -116,7 +116,7 @@ func (h *GooglePubSubServiceAttributeHandler) Create(_ context.Context, d *schem
 func (h *GooglePubSubServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Google Cloud Pub/Sub logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListPubsubs(&gofastly.ListPubsubsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_heroku.go

@@ -101,7 +101,7 @@ func (h *HerokuServiceAttributeHandler) Create(_ context.Context, d *schema.Reso
 func (h *HerokuServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Heroku logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListHerokus(&gofastly.ListHerokusInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_honeycomb.go

@@ -98,7 +98,7 @@ func (h *HoneycombServiceAttributeHandler) Create(_ context.Context, d *schema.R
 func (h *HoneycombServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Honeycomb logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListHoneycombs(&gofastly.ListHoneycombsInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_https.go

@@ -165,7 +165,7 @@ func (h *HTTPSLoggingServiceAttributeHandler) Create(_ context.Context, d *schem
 func (h *HTTPSLoggingServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing HTTPS logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListHTTPS(&gofastly.ListHTTPSInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_kafka.go

@@ -164,7 +164,7 @@ func (h *KafkaServiceAttributeHandler) Create(_ context.Context, d *schema.Resou
 func (h *KafkaServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Kafka logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListKafkas(&gofastly.ListKafkasInput{
 			ServiceID:      d.Id(),

fastly/block_fastly_service_logging_kinesis.go

@@ -116,7 +116,7 @@ func (h *KinesisServiceAttributeHandler) Create(_ context.Context, d *schema.Res
 func (h *KinesisServiceAttributeHandler) Read(_ context.Context, d *schema.ResourceData, _ map[string]any, serviceVersion int, conn *gofastly.Client) error {
 	localState := d.Get(h.GetKey()).(*schema.Set).List()
 
-	if len(localState) > 0 || d.Get("imported").(bool) {
+	if len(localState) > 0 || d.Get("imported").(bool) || d.Get("force_refresh").(bool) {
 		log.Printf("[DEBUG] Refreshing Kinesis logging endpoints for (%s)", d.Id())
 		remoteState, err := conn.ListKinesis(&gofastly.ListKinesisInput{
 			ServiceID:      d.Id(),