fix: allow defaulted legacy watch-list options

Author: ThomasK33

internal/aggregated/storage/watch.go

@@ -45,8 +45,12 @@ func validateUnsupportedWatchListOptions(opts *metainternalversion.ListOptions)
 		return nil
 	}
 
-	if opts.SendInitialEvents != nil {
-		return fmt.Errorf("sendInitialEvents is not supported for this watch endpoint")
+	if isDefaultedLegacyWatchListOptions(opts) {
+		return nil
+	}
+
+	if opts.SendInitialEvents != nil && *opts.SendInitialEvents {
+		return fmt.Errorf("sendInitialEvents=true is not supported for this watch endpoint")
 	}
 	if opts.ResourceVersionMatch != "" {
 		return fmt.Errorf(
@@ -58,6 +62,20 @@ func validateUnsupportedWatchListOptions(opts *metainternalversion.ListOptions)
 	return nil
 }
 
+func isDefaultedLegacyWatchListOptions(opts *metainternalversion.ListOptions) bool {
+	if opts == nil {
+		return false
+	}
+	if opts.SendInitialEvents == nil || !*opts.SendInitialEvents {
+		return false
+	}
+	if opts.ResourceVersionMatch != metav1.ResourceVersionMatchNotOlderThan {
+		return false
+	}
+
+	return opts.ResourceVersion == "" || opts.ResourceVersion == "0"
+}
+
 // filterForListOptions builds a watch.FilterFunc that applies namespace, label, and field selector filtering.
 // Returns nil if no filtering is needed.
 func filterForListOptions(requestNamespace string, opts *metainternalversion.ListOptions) (watch.FilterFunc, error) {

internal/aggregated/storage/watch_test.go

@@ -339,6 +339,45 @@ func TestTemplateWatchRejectsUnsupportedWatchListOptions(t *testing.T) {
 	})
 }
 
+func TestWatchAllowsDefaultedLegacyWatchListOptions(t *testing.T) {
+	t.Parallel()
+
+	server, _ := newMockCoderServer(t)
+	defer server.Close()
+
+	workspaceStorage := NewWorkspaceStorage(newTestClientProvider(t, server.URL))
+	defer workspaceStorage.Destroy()
+	templateStorage := NewTemplateStorage(newTestClientProvider(t, server.URL))
+	defer templateStorage.Destroy()
+
+	ctx := namespacedContext("control-plane")
+	sendInitialEvents := true
+	legacyWatchOptions := &metainternalversion.ListOptions{
+		Watch:                true,
+		ResourceVersion:      "",
+		SendInitialEvents:    &sendInitialEvents,
+		ResourceVersionMatch: metav1.ResourceVersionMatchNotOlderThan,
+	}
+
+	workspaceWatcher, err := workspaceStorage.Watch(ctx, legacyWatchOptions)
+	if err != nil {
+		t.Fatalf("expected workspace watch to accept defaulted legacy watch options: %v", err)
+	}
+	if workspaceWatcher == nil {
+		t.Fatal("assertion failed: workspace watcher must not be nil")
+	}
+	workspaceWatcher.Stop()
+
+	templateWatcher, err := templateStorage.Watch(ctx, legacyWatchOptions)
+	if err != nil {
+		t.Fatalf("expected template watch to accept defaulted legacy watch options: %v", err)
+	}
+	if templateWatcher == nil {
+		t.Fatal("assertion failed: template watcher must not be nil")
+	}
+	templateWatcher.Stop()
+}
+
 func TestValidateUnsupportedWatchListOptions(t *testing.T) {
 	t.Parallel()
 
@@ -351,9 +390,29 @@ func TestValidateUnsupportedWatchListOptions(t *testing.T) {
 	}
 
 	sendInitialEvents := true
+	legacyOptionsWithEmptyRV := &metainternalversion.ListOptions{
+		Watch:                true,
+		ResourceVersion:      "",
+		SendInitialEvents:    &sendInitialEvents,
+		ResourceVersionMatch: metav1.ResourceVersionMatchNotOlderThan,
+	}
+	if err := validateUnsupportedWatchListOptions(legacyOptionsWithEmptyRV); err != nil {
+		t.Fatalf("expected defaulted legacy watch-list options with empty RV to be accepted, got %v", err)
+	}
+
+	legacyOptionsWithZeroRV := &metainternalversion.ListOptions{
+		Watch:                true,
+		ResourceVersion:      "0",
+		SendInitialEvents:    &sendInitialEvents,
+		ResourceVersionMatch: metav1.ResourceVersionMatchNotOlderThan,
+	}
+	if err := validateUnsupportedWatchListOptions(legacyOptionsWithZeroRV); err != nil {
+		t.Fatalf("expected defaulted legacy watch-list options with RV=0 to be accepted, got %v", err)
+	}
+
 	err := validateUnsupportedWatchListOptions(&metainternalversion.ListOptions{SendInitialEvents: &sendInitialEvents})
 	if err == nil {
-		t.Fatal("expected sendInitialEvents to be rejected")
+		t.Fatal("expected sendInitialEvents=true without matching legacy defaults to be rejected")
 	}
 	if !strings.Contains(err.Error(), "sendInitialEvents") {
 		t.Fatalf("expected sendInitialEvents error, got %v", err)
@@ -363,11 +422,24 @@ func TestValidateUnsupportedWatchListOptions(t *testing.T) {
 		ResourceVersionMatch: metav1.ResourceVersionMatchNotOlderThan,
 	})
 	if err == nil {
-		t.Fatal("expected resourceVersionMatch to be rejected")
+		t.Fatal("expected resourceVersionMatch without matching legacy defaults to be rejected")
 	}
 	if !strings.Contains(err.Error(), "resourceVersionMatch") {
 		t.Fatalf("expected resourceVersionMatch error, got %v", err)
 	}
+
+	err = validateUnsupportedWatchListOptions(&metainternalversion.ListOptions{
+		Watch:                true,
+		ResourceVersion:      "12345",
+		SendInitialEvents:    &sendInitialEvents,
+		ResourceVersionMatch: metav1.ResourceVersionMatchNotOlderThan,
+	})
+	if err == nil {
+		t.Fatal("expected non-legacy watch-list options to be rejected")
+	}
+	if !strings.Contains(err.Error(), "sendInitialEvents") {
+		t.Fatalf("expected non-legacy watch-list rejection to reference sendInitialEvents, got %v", err)
+	}
 }
 
 func TestValidateFieldSelector(t *testing.T) {