fix: update code according to latest terraform schema expiration_poli…

…cy.ttl
coder · ssncferreira · May 26, 2025 · May 22, 2025 · May 23, 2025 · May 23, 2025
commit c7e442ca8b3e054c00a5e7cb184444caa0a8d8fa
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/prebuilds.sql b/coderd/database/queries/prebuilds.sql
@@ -35,7 +35,7 @@ SELECT
 		tvp.id,
 		tvp.name,
 		tvp.desired_instances       AS desired_instances,
-		tvp.invalidate_after_secs 	AS invalidate_after_secs,
+		tvp.invalidate_after_secs 	AS ttl,
 		tvp.prebuild_status,
 		t.deleted,
 		t.deprecated != ''          AS deprecated

diff --git a/coderd/prebuilds/global_snapshot.go b/coderd/prebuilds/global_snapshot.go
@@ -81,14 +81,14 @@ func (s GlobalSnapshot) FilterByPreset(presetID uuid.UUID) (*PresetSnapshot, err
 }
 
 // filterExpiredWorkspaces splits running workspaces into expired and non-expired
-// based on the preset's InvalidateAfterSecs TTL. If TTL is missing or zero,
-// all workspaces are considered non-expired.
+// based on the preset's TTL.
+// If TTL is missing or zero, all workspaces are considered non-expired.
 func filterExpiredWorkspaces(preset database.GetTemplatePresetsWithPrebuildsRow, runningWorkspaces []database.GetRunningPrebuiltWorkspacesRow) (nonExpired []database.GetRunningPrebuiltWorkspacesRow, expired []database.GetRunningPrebuiltWorkspacesRow) {
-	if !preset.InvalidateAfterSecs.Valid {
+	if !preset.Ttl.Valid {
 		return runningWorkspaces, expired
 	}
 
-	ttl := time.Duration(preset.InvalidateAfterSecs.Int32) * time.Second
+	ttl := time.Duration(preset.Ttl.Int32) * time.Second
 	if ttl <= 0 {
 		return runningWorkspaces, expired
 	}

diff --git a/coderd/prebuilds/preset_snapshot_test.go b/coderd/prebuilds/preset_snapshot_test.go
@@ -670,14 +670,14 @@ func TestExpiredPrebuilds(t *testing.T) {
 			// GIVEN: running prebuilt workspaces for the preset.
 			running := make([]database.GetRunningPrebuiltWorkspacesRow, 0, tc.running)
 			expiredCount := 0
-			cacheInvalidationDuration := time.Duration(defaultPreset.InvalidateAfterSecs.Int32)
+			ttlDuration := time.Duration(defaultPreset.Ttl.Int32)
 			for range tc.running {
 				name, err := prebuilds.GenerateName()
 				require.NoError(t, err)
 				prebuildCreateAt := time.Now()
 				if int(tc.expired) > expiredCount {
 					// Update the prebuild workspace createdAt to exceed its TTL
-					prebuildCreateAt = prebuildCreateAt.Add(-cacheInvalidationDuration - 2*time.Second)
+					prebuildCreateAt = prebuildCreateAt.Add(-ttlDuration - 2*time.Second)
 					expiredCount++
 				}
 				running = append(running, database.GetRunningPrebuiltWorkspacesRow{
@@ -937,7 +937,7 @@ func preset(active bool, instances int32, opts options, muts ...func(row databas
 		},
 		Deleted:    false,
 		Deprecated: false,
-		InvalidateAfterSecs: sql.NullInt32{
+		Ttl: sql.NullInt32{
 			Valid: true,
 			Int32: 2,
 		},

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -2059,15 +2059,15 @@ func InsertWorkspacePresetsAndParameters(ctx context.Context, logger slog.Logger
 
 func InsertWorkspacePresetAndParameters(ctx context.Context, db database.Store, templateVersionID uuid.UUID, protoPreset *sdkproto.Preset, t time.Time) error {
 	err := db.InTx(func(tx database.Store) error {
-		var desiredInstances, invalidateAfterSecs sql.NullInt32
+		var desiredInstances, ttl sql.NullInt32
 		if protoPreset != nil && protoPreset.Prebuild != nil {
 			desiredInstances = sql.NullInt32{
 				Int32: protoPreset.Prebuild.Instances,
 				Valid: true,
 			}
-			if protoPreset.Prebuild.CacheInvalidation != nil {
-				invalidateAfterSecs = sql.NullInt32{
-					Int32: protoPreset.Prebuild.CacheInvalidation.InvalidateAfterSecs,
+			if protoPreset.Prebuild.ExpirationPolicy != nil {
+				ttl = sql.NullInt32{
+					Int32: protoPreset.Prebuild.ExpirationPolicy.Ttl,
 					Valid: true,
 				}
 			}
@@ -2078,7 +2078,7 @@ func InsertWorkspacePresetAndParameters(ctx context.Context, db database.Store,
 			Name:                protoPreset.Name,
 			CreatedAt:           t,
 			DesiredInstances:    desiredInstances,
-			InvalidateAfterSecs: invalidateAfterSecs,
+			InvalidateAfterSecs: ttl,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert preset: %w", err)

diff --git a/docs/admin/templates/extending-templates/prebuilt-workspaces.md b/docs/admin/templates/extending-templates/prebuilt-workspaces.md
@@ -31,7 +31,7 @@ Prebuilt workspaces are tightly integrated with [workspace presets](./parameters
 ## Enable prebuilt workspaces for template presets
 
 In your template, add a `prebuilds` block within a `coder_workspace_preset` definition to identify the number of prebuilt
-instances your Coder deployment should maintain, and optionally configure a `cache_invalidation` block to set a TTL
+instances your Coder deployment should maintain, and optionally configure a `expiration_policy` block to set a TTL
 (Time To Live) for unclaimed prebuilt workspaces to ensure stale resources are automatically cleaned up.
 
    ```hcl
@@ -43,9 +43,9 @@ instances your Coder deployment should maintain, and optionally configure a `cac
        memory        = 16
      }
      prebuilds {
-       instances = 3  # Number of prebuilt workspaces to maintain
-       cache_invalidation {
-          invalidate_after_secs = 86400  # Time (in seconds) after which unclaimed prebuilds are expired (1 day)
+       instances = 3   # Number of prebuilt workspaces to maintain
+       expiration_policy {
+          ttl = 86400  # Time (in seconds) after which unclaimed prebuilds are expired (1 day)
       }
      }
    }
@@ -54,8 +54,8 @@ instances your Coder deployment should maintain, and optionally configure a `cac
 After you publish a new template version, Coder will automatically provision and maintain prebuilt workspaces through an
 internal reconciliation loop (similar to Kubernetes) to ensure the defined `instances` count are running.
 
-The `cache_invalidation` block ensures that any prebuilt workspaces left unclaimed for more than `invalidate_after_secs`
-seconds is considered expired and automatically cleaned up.
+The `expiration_policy` block ensures that any prebuilt workspaces left unclaimed for more than `ttl` seconds is considered
+expired and automatically cleaned up.
 
 ## Prebuilt workspace lifecycle
 
@@ -102,10 +102,10 @@ Unclaimed prebuilt workspaces can be interacted with in the same way as any othe
 However, if a Prebuilt workspace is stopped, the reconciliation loop will not destroy it.
 This gives template admins the ability to park problematic prebuilt workspaces in a stopped state for further investigation.
 
-### Cache Invalidation
+### Expiration Policy
 
-Prebuilt workspaces support cache invalidation through the `invalidate_after_secs` setting inside the `cache_invalidation`
-block. This value defines the Time To Live (TTL) of a prebuilt workspace, i.e., the duration in seconds that an unclaimed
+Prebuilt workspaces support expiration policies through the `ttl` setting inside the `expiration_policy` block.
+This value defines the Time To Live (TTL) of a prebuilt workspace, i.e., the duration in seconds that an unclaimed
 prebuilt workspace can remain before it is considered expired and eligible for cleanup.
 
 Expired prebuilt workspaces are removed during the reconciliation loop to avoid stale environments and resource waste.

diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -897,21 +897,21 @@
 			)
 		}
 		var prebuildInstances int32
-		var cacheInvalidation *proto.CacheInvalidation
+		var expirationPolicy *proto.ExpirationPolicy
 		if len(preset.Prebuilds) > 0 {
 			prebuildInstances = int32(math.Min(math.MaxInt32, float64(preset.Prebuilds[0].Instances)))
-			if len(preset.Prebuilds[0].CacheInvalidation) > 0 {
-				cacheInvalidation = &proto.CacheInvalidation{
-					InvalidateAfterSecs: int32(math.Min(math.MaxInt32, float64(preset.Prebuilds[0].CacheInvalidation[0].InvalidateAfterSecs))),
+			if len(preset.Prebuilds[0].ExpirationPolicy) > 0 {
+				expirationPolicy = &proto.ExpirationPolicy{
+					Ttl: int32(math.Min(math.MaxInt32, float64(preset.Prebuilds[0].ExpirationPolicy[0].TTL))),
 				}
 			}
 		}
 		protoPreset := &proto.Preset{
 			Name:       preset.Name,
 			Parameters: presetParameters,
 			Prebuild: &proto.Prebuild{
-				Instances:         prebuildInstances,
-				CacheInvalidation: cacheInvalidation,
+				Instances:        prebuildInstances,
+				ExpirationPolicy: expirationPolicy,
 			},
 		}
 

diff --git a/provisioner/terraform/resources_test.go b/provisioner/terraform/resources_test.go
@@ -830,8 +830,8 @@ func TestConvertResources(t *testing.T) {
 				}},
 				Prebuild: &proto.Prebuild{
 					Instances: 4,
-					CacheInvalidation: &proto.CacheInvalidation{
-						InvalidateAfterSecs: 86400,
+					ExpirationPolicy: &proto.ExpirationPolicy{
+						Ttl: 86400,
 					},
 				},
 			}},

diff --git a/provisioner/terraform/testdata/resources/presets/presets.tf b/provisioner/terraform/testdata/resources/presets/presets.tf
@@ -25,8 +25,8 @@ data "coder_workspace_preset" "MyFirstProject" {
   }
   prebuilds {
     instances = 4
-    cache_invalidation {
-      invalidate_after_secs = 86400
+    expiration_policy {
+      ttl = 86400
     }
   }
 }