Graduate Counters and Lists to Beta

[Kalaiselvi84]

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup
/kind documentation

/kind feature

/kind hotfix
/kind release

What this PR does / Why we need it:

Which issue(s) this PR fixes:

work on #3775

Special notes for your reviewer:

[agones-bot]

Build Failed 😱

Build Id: 95fef972-709e-47e2-ab60-3cbd184e3b40

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[agones-bot]

Build Failed 😱

Build Id: c3ff642e-3f39-4547-8ebe-0c8c37d2b5de

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[zmerlynn]

@igooch Do you want to LGTM as well?

[agones-bot]

Build Failed 😱

Build Id: d65ce6af-52b7-4b4a-adfe-12faa95d38ed

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[agones-bot]

Build Failed 😱

Build Id: b3a4af55-25e1-4530-abd5-08105597fc37

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[zmerlynn]

I am reminded by the build failures that we need to graduate the SDKs as well!

[zmerlynn]

(Taking out of approved.)

[agones-bot]

Build Failed 😱

Build Id: b9766c28-7472-4c0f-a7df-0289f0bc4788

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[agones-bot]

Build Failed 😱

Build Id: cdd9d609-a40b-446c-b49f-54216255b126

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[Kalaiselvi84]

we need to graduate the SDKs as well!

@zmerlynn could you please let me know the steps to graduate CountsAndLists in the SDKs

[zmerlynn]

This is really two parts:

• SDK Server: So..
  • you'll need to move all of the Counts & Lists Alpha protos:

    agones/proto/sdk/alpha/alpha.proto

    Lines 132 to 189 in 2e34147

    	// Gets a Counter. Returns NOT_FOUND if the Counter does not exist.
    	rpc GetCounter(GetCounterRequest) returns (Counter) {
    	option (google.api.http) = {
    	get: "/v1alpha1/counters/{name}"
    	};
    	option (google.api.method_signature) = "name";
    	}
    	// UpdateCounter returns the updated Counter. Returns NOT_FOUND if the Counter does not exist (name cannot be updated).
    	// Returns OUT_OF_RANGE if the Count is out of range [0,Capacity].
    	rpc UpdateCounter(UpdateCounterRequest) returns (Counter) {
    	option (google.api.http) = {
    	patch: "/v1alpha1/counters/{counterUpdateRequest.name}"
    	body: "counterUpdateRequest"
    	};
    	option (google.api.method_signature) = "counterUpdateRequest";
    	}
    	// Gets a List. Returns NOT_FOUND if the List does not exist.
    	rpc GetList(GetListRequest) returns (List) {
    	option (google.api.http) = {
    	get: "/v1alpha1/lists/{name}"
    	};
    	option (google.api.method_signature) = "name";
    	}
    	// UpdateList returns the updated List. Returns NOT_FOUND if the List does not exist (name cannot be updated).
    	// **THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES**
    	// Use AddListValue() or RemoveListValue() for modifying the List.Values field.
    	// Returns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the List.
    	// If a field mask path(s) is specified, but the value is not set in the request List object,
    	// then the default value for the variable will be set (i.e. 0 for "capacity", empty list for "values").
    	rpc UpdateList(UpdateListRequest) returns (List) {
    	option (google.api.http) = {
    	patch: "/v1alpha1/lists/{list.name}"
    	body: "list"
    	};
    	option (google.api.method_signature) = "list,update_mask";
    	}
    	// Adds a value to a List and returns updated List. Returns NOT_FOUND if the List does not exist.
    	// Returns ALREADY_EXISTS if the value is already in the List.
    	// Returns OUT_OF_RANGE if the List is already at Capacity.
    	rpc AddListValue(AddListValueRequest) returns (List) {
    	option (google.api.http) = {
    	post: "/v1alpha1/lists/{name}:addValue"
    	body: "*"
    	};
    	}
    	// Removes a value from a List and returns updated List. Returns NOT_FOUND if the List does not exist.
    	// Returns NOT_FOUND if the value is not in the List.
    	rpc RemoveListValue(RemoveListValueRequest) returns (List) {
    	option (google.api.http) = {
    	post: "/v1alpha1/lists/{name}:removeValue"
    	body: "*"
    	};
    	}

    to the Beta proto, which is currently empty: https://github.com/googleforgames/agones/blob/main/proto/sdk/beta/beta.proto
  • and then change the sdk-server receiver to take the Beta types
• But then in each SDK, you basically need to move the functions over from the "alpha" surface of the SDK to the "beta" surface.
  • But we don't actually have a Beta surface on any of these, e.g. Golang:

    agones/sdks/go/sdk.go

    Line 42 in 2e34147

    alpha *Alpha

    .. so you'll need to add those

It's .. a little intense.

[markmandel]

I have make run-sdk-conformance-test-go working, I'll let you duplicate on the csharp SDK test.

Added the changes as a patch file, if that's easier:
updates.PATCH

[markmandel]

This should be:

$(MAKE) run-sdk-conformance-test SDK_FOLDER=go GRPC_PORT=9001 HTTP_PORT=9101 TESTS=$(DEFAULT_CONFORMANCE_TESTS),$(COUNTS_AND_LISTS_TESTS)

As it needs to be told to check the Counter and Lists tests, since it's now enabled!

[Kalaiselvi84]

Sorry, this fix isn't working for the C# and rest tests. Could there be something missing to enable the CL feature for these two tests? Please guide.

C# test log
rest test log

[igooch]

For C# the tests are not running because of these lines:

agones/test/sdk/csharp/Program.cs

Line 169 in db84735

if (featureGates.Contains("CountsAndLists"))

agones/test/sdk/csharp/Program.cs

Line 295 in db84735

if (featureGates.Contains("CountsAndLists"))

Which is picking up DOCKER_RUN_ARGS="--net host -e AGONES_SDK_GRPC_PORT=9005 -e AGONES_SDK_HTTP_PORT=9105 -e FEATURE_GATES=''

Even though the feature gate is enabled by default {"ctlConf":{"GameServerName":"","PodNamespace":"","Address":"","IsLocal":false,"LocalFile":"","Delay":2,"Timeout":40,"Test":"ready,allocate,setlabel,setannotation,gameserver,health,shutdown,watch,reserve,getcounter,updatecounter,setcountcounter,setcapacitycounter,getlist,updatelist,addlistvalue,removelistvalue","TestSdkName":"csharp","KubeConfig":"","GracefulTermination":true,"GRPCPort":9005,"HTTPPort":9105,"LogLevel":""},"featureGates":"CountsAndLists=true\u0026DisableResyncOnSDKServer=true\u0026Example=false\u0026GKEAutopilotExtendedDurationPods=false\u0026PlayerAllocationFilter=false\u0026PlayerTracking=false","message":"Starting sdk sidecar","severity":"info","source":"main","time":"2024-04-25T22:01:36.795794579Z","version":"1.41.0-dev-d0a74b1"}

[igooch]

Right now I'm thinking the easiest solution would be to create a BETA_FEATURE_GATES similar to the

agones/build/Makefile

Line 67 in db84735

ALPHA_FEATURE_GATES ?= "PlayerAllocationFilter=true&PlayerTracking=true&CountsAndLists=true&Example=true"

. Otherwise we'll need some way for C# to access "agones.dev/agones/pkg/util/runtime" similar to Go runtime.FeatureEnabled(runtime.FeatureCountsAndLists).

[Kalaiselvi84]

Would you mind submitting a PR to fix these two tests, please?

[igooch]

Added a commit.

A note: The Go SDK can see the runtime state of the SDK config, by using runtime.FeatureEnabled(runtime.FeatureCountsAndLists). That means that for the first Go sdk conformance test Beta is on and Alpha is off, and for the second Go sdk conformance test both Alpha and Beta are on.

For REST and C# they can't see the runtime config, and depend on an environment variable being passed through. This means that for the first C# and REST tests Beta is on and Alpha is off, and for the second test Beta is off and Alpha is on.

[agones-bot]

Build Failed 😱

Build Id: bd6c4c71-3e1a-4e32-a98b-1b4d5c9c70a4

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[agones-bot]

Build Failed 😱

Build Id: b48fe5d6-664a-42ac-b18c-7d5a31f464dd

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[agones-bot]

Build Succeeded 👏

Build Id: 46572f7f-f529-4f7e-8016-69fac8c102ab

The following development artifacts have been built, and will exist for the next 30 days:

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.41.0-dev-ccd6668-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.41.0-dev-ccd6668-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.41.0-dev-ccd6668-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.41.0-dev-ccd6668-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.41.0-dev-ccd6668-amd64
• Linux C++ SDK (build): agonessdk-1.41.0-dev-ccd6668-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.41.0-dev-ccd6668-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://ccd6668-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3801/head:pr_3801 && git checkout pr_3801
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.41.0-dev-ccd6668-amd64

[agones-bot]

Build Succeeded 👏

Build Id: 0e046e05-9248-48a1-b0e2-48a654ea20ec

The following development artifacts have been built, and will exist for the next 30 days:

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.41.0-dev-9b45d3c-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.41.0-dev-9b45d3c-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.41.0-dev-9b45d3c-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.41.0-dev-9b45d3c-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.41.0-dev-9b45d3c-amd64
• Linux C++ SDK (build): agonessdk-1.41.0-dev-9b45d3c-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.41.0-dev-9b45d3c-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://9b45d3c-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3801/head:pr_3801 && git checkout pr_3801
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.41.0-dev-9b45d3c-amd64

[igooch]

LGTM