feat: enhance Kubernetes client with watch functionality #1667

lqlive · 2025-09-15T02:55:52Z

Base on #1662
@tg123 Hi ,This is my initial implementation. Could you help me see how much it differs from your ideas?

During my implementation, I thought of two issues:

1.Can the ListNamespacedPodWithHttpMessagesAsync method be set as protected or private to prevent external access?

2.Replace the tuple (WatchEventType, V1Pod) in IAsyncEnumerable<(WatchEventType, V1Pod)> with a new type, such as:

public readonly struct ResourceEvent<TResource>(EventType eventType, TResource value, TResource oldValue = default!)
{
    public EventType EventType { get; } = eventType;
    public TResource OldValue { get; } = oldValue;
    public TResource Value { get; } = value;
}

public enum EventType
{
    Unknown = 0,
    Created = 1,
    Updated = 2,
    Deleted = 3
}

Copilot

Pull Request Overview

This PR enhances the Kubernetes C# client with watch functionality by adding code generation support for watch operations. The implementation provides both callback-based and async enumerable patterns for watching Kubernetes resources.

Adds watch operation code generation to client templates
Introduces parameter filtering to exclude the "watch" parameter from generated methods
Updates examples to demonstrate the new watch functionality

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
OperationsExtensions.cs.template	Adds watch operation generation with callback and async enumerable patterns
Client.cs.template	Generates watch methods in client classes with filtered parameters
TypeHelper.cs	Adds support for extracting single item types from list types
ParamHelper.cs	Implements parameter filtering and watch-specific parameter handling
KubernetesClient.Aot.csproj	Enables Watcher classes in AOT build
Program.cs (examples)	Updates watch and clientset examples to use new API

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/LibKubernetesGenerator/ParamHelper.cs

src/LibKubernetesGenerator/templates/OperationsExtensions.cs.template

examples/watch/Program.cs

examples/clientset/Program.cs

tg123

could you please also change e2e test and watcher related test?

and lets mark direct call to watch() deprecated, will be removed next version

src/KubernetesClient.Aot/KubernetesClient.Aot.csproj

examples/watch/Program.cs

…ling methods and add async enumerable support

k8s-ci-robot · 2025-09-17T07:14:17Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: lqlive
Once this PR has been reviewed and has the lgtm label, please ask for approval from tg123. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

lqlive · 2025-09-17T07:53:28Z

could you please also change e2e test and watcher related test?

I'm adding some unit tests for WatchAsync. Can you help me check if there are any missing points?

and lets mark direct call to watch() deprecated, will be removed next version

XXXXXWithHttpMessagesAsync Added Obsolete attribute

…olete attribute formatting

lqlive · 2025-09-18T01:48:17Z

@tg123 Please re-run CI. Yesterday I pulled the latest code

… Obsolete attribute formatting

…ing TryGetItemTypeFromSchema method

src/LibKubernetesGenerator/TypeHelper.cs

src/KubernetesClient.Aot/KubernetesClient.Aot.csproj

src/LibKubernetesGenerator/templates/IOperations.cs.template

src/LibKubernetesGenerator/TypeHelper.cs

tg123

overall lgtm

lets close on weather hide bool watch or watcherext, then we can merge

tg123 · 2025-09-29T08:08:49Z

src/KubernetesClient/WatcherExt.cs

        /// <returns>IAsyncEnumerable of watch events</returns>
+        [Obsolete("This method will be deprecated in future versions.")] 
        public static IAsyncEnumerable<(WatchEventType, T)> WatchAsync<T, L>(
            this Task<HttpOperationResponse<L>> responseTask,


i think we should not filter bool watch in list at the moment
otherwise, this WatchExt cant work anymore for old code

so what do you think, make those internal or keep compatible until next version?

I think it's best to just change it to internal so we don't forget to remove it in a future version.

cc @brendanburns for ideas
internal it will create a big breaking change and users have to to migrate their code to new WatchXXX
do you think if it is nessary to wait one more big version?

cc @brendanburns for ideas internal it will create a big breaking change and users have to to migrate their code to new WatchXXX do you think if it is nessary to wait one more big version?

It seems that @ is wrong. It should be @brendandburns

src/LibKubernetesGenerator/TypeHelper.cs

Copilot

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/KubernetesClient.Tests/WatchTests.cs

Copilot · 2025-09-29T08:11:18Z

src/LibKubernetesGenerator/TypeHelper.cs

+            var listSchema = response?.Schema?.Reference;
+            if (listSchema?.Properties?.TryGetValue("items", out var itemsProperty) != true)


The code attempts to access Properties on Reference which is incorrect. The Reference property is a string reference to a schema definition, not the actual schema object. This should be accessing the resolved schema object instead of the reference.

Suggested change

var listSchema = response?.Schema?.Reference;

if (listSchema?.Properties?.TryGetValue("items", out var itemsProperty) != true)

// Resolve the schema reference to the actual schema object

var referencedSchema = response?.Schema?.ActualSchema;

if (referencedSchema?.Properties?.TryGetValue("items", out var itemsProperty) != true)

examples/clientset/Program.cs

…ributes; improve example method signature in Program.cs

Copilot

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-29T18:13:38Z

tests/KubernetesClient.Tests/WatchTests.cs

-            await client.CoreV1.ListNamespacedPodWithHttpMessagesAsync("default", watch: true).ConfigureAwait(true);
+            using var watcher = client.CoreV1.WatchListNamespacedPod("default", onEvent: (type, item) => { });
            Assert.Equal(HttpVersion.Version20, handler.Version);
+            await Task.CompletedTask.ConfigureAwait(true);


The statement await Task.CompletedTask.ConfigureAwait(true) is unnecessary since Task.CompletedTask is already completed synchronously. This line can be removed.

Suggested change

await Task.CompletedTask.ConfigureAwait(true);

Copilot · 2025-09-29T18:13:38Z

src/LibKubernetesGenerator/TypeHelper.cs

+            var listSchema = response?.Schema?.Reference;
+            if (listSchema?.Properties?.TryGetValue("items", out var itemsProperty) != true)
+            {
+                return null;
+            }


The method attempts to access Properties on a JsonReference object, but JsonReference doesn't have a Properties property. This will always return null. You should resolve the reference first to get the actual schema.

Suggested change

var listSchema = response?.Schema?.Reference;

if (listSchema?.Properties?.TryGetValue("items", out var itemsProperty) != true)

{

return null;

}

// Resolve the reference to the actual schema before accessing Properties

var referencedSchema = response?.Schema?.Reference as JsonSchema;

if (referencedSchema == null)

{

return null;

}

if (!referencedSchema.Properties.TryGetValue("items", out var itemsProperty))

{

return null;

}

feat: enhance Kubernetes client with watch functionality

80b46b7

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 15, 2025

k8s-ci-robot requested review from brendandburns and tg123 September 15, 2025 02:55

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 15, 2025

tg123 requested a review from Copilot September 15, 2025 17:04

Copilot AI reviewed Sep 15, 2025

View reviewed changes

src/LibKubernetesGenerator/ParamHelper.cs Show resolved Hide resolved

src/LibKubernetesGenerator/templates/OperationsExtensions.cs.template Show resolved Hide resolved

examples/watch/Program.cs Outdated Show resolved Hide resolved

examples/clientset/Program.cs Outdated Show resolved Hide resolved

refactor: simplify watch event handling in Kubernetes client example

6979dd5

tg123 self-assigned this Sep 16, 2025

tg123 reviewed Sep 16, 2025

View reviewed changes

src/KubernetesClient.Aot/KubernetesClient.Aot.csproj Outdated Show resolved Hide resolved

examples/watch/Program.cs Outdated Show resolved Hide resolved

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 17, 2025

refactor: update Kubernetes watch functionality to use new event hand…

136b103

…ling methods and add async enumerable support

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 17, 2025

lqlive added 2 commits September 17, 2025 15:17

fix

f9a3d9c

fix

201be85

Merge branch 'master' into master

942a645

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 17, 2025

fix: correct usage of Pod list items in client example and update Obs…

9ac1f9c

…olete attribute formatting

lqlive added 3 commits September 23, 2025 10:31

fix: update client example to use correct Pod list method and improve…

4d752ed

… Obsolete attribute formatting

Merge branch 'kubernetes-client:master' into master

5e47c09

refactor: enhance type resolution for list items in TypeHelper by add…

6de5558

…ing TryGetItemTypeFromSchema method

lqlive commented Sep 23, 2025

View reviewed changes

src/LibKubernetesGenerator/TypeHelper.cs Show resolved Hide resolved

tg123 reviewed Sep 23, 2025

View reviewed changes

src/KubernetesClient.Aot/KubernetesClient.Aot.csproj Outdated Show resolved Hide resolved

src/LibKubernetesGenerator/templates/IOperations.cs.template Outdated Show resolved Hide resolved

src/LibKubernetesGenerator/TypeHelper.cs Show resolved Hide resolved

lqlive added 2 commits September 24, 2025 09:22

feat: mark Watch methods as obsolete to prepare for future deprecation

c6bda21

fix

85d7011

tg123 reviewed Sep 29, 2025

View reviewed changes

tg123 requested a review from Copilot September 29, 2025 08:10

Copilot AI reviewed Sep 29, 2025

View reviewed changes

refactor: update WatcherExt class to internal and remove obsolete att…

0877710

…ributes; improve example method signature in Program.cs

tg123 requested a review from Copilot September 29, 2025 18:12

Copilot AI reviewed Sep 29, 2025

View reviewed changes

		var listSchema = response?.Schema?.Reference;
		if (listSchema?.Properties?.TryGetValue("items", out var itemsProperty) != true)

-            var listSchema = response?.Schema?.Reference;
-            if (listSchema?.Properties?.TryGetValue("items", out var itemsProperty) != true)
+            // Resolve the schema reference to the actual schema object
+            var referencedSchema = response?.Schema?.ActualSchema;
+            if (referencedSchema?.Properties?.TryGetValue("items", out var itemsProperty) != true)

feat: enhance Kubernetes client with watch functionality #1667

Are you sure you want to change the base?

feat: enhance Kubernetes client with watch functionality #1667

Conversation

lqlive commented Sep 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tg123 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

k8s-ci-robot commented Sep 17, 2025

Uh oh!

lqlive commented Sep 17, 2025

Uh oh!

lqlive commented Sep 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tg123 left a comment

Choose a reason for hiding this comment

Uh oh!

tg123 Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

lqlive Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

tg123 Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

lqlive Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!