SDK Matrices for NodeJS, C#, CPP, REST #3548

Kalaiselvi84 · 2023-12-18T18:52:22Z

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:
Included SDK functionality table for NodeJS, CSharp, REST, and CPP.

Which issue(s) this PR fixes:

Work on #2716

Special notes for your reviewer:

agones-bot · 2023-12-18T19:06:49Z

Build Failed 😱

Build Id: 7daaf50b-1995-4d8b-b06d-0d10c8bb6c47

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

gongmax · 2023-12-18T19:13:17Z

one failed unit test

--- FAIL: TestControllerGameServersNodeState (10.00s)
    controller_test.go:442: 
        	Error Trace:	/go/src/agones.dev/agones/pkg/metrics/controller_test.go:442
        	Error:      	Condition never satisfied
        	Test:       	TestControllerGameServersNodeState
    controller_test.go:74: 
        	Error Trace:	/go/src/agones.dev/agones/pkg/metrics/controller_test.go:74
        	            				/go/src/agones.dev/agones/pkg/metrics/controller_test.go:460
        	Error:      	Expected value not to be nil.
        	Test:       	TestControllerGameServersNodeState
        	Messages:   	No metric found with name: gameservers_node_count
{"message":"Wait for cache sync","severity":"info","time":"2023-12-18T19:04:29.818819854Z"}
FAIL

Retrying...

gongmax

Looking at the doc for other SDKs, the function matrix is at the top. Eg https://agones.dev/site/docs/guides/client-sdks/rust/#sdk-functionality. Can you follow the same pattern?

agones-bot · 2023-12-18T20:06:30Z

Build Succeeded 👏

Build Id: 893aa74f-417c-4c9d-9b47-445a8c0ab3fa

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

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

https://0493526-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3548/head:pr_3548 && git checkout pr_3548
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.37.0-dev-0493526-amd64

Kalaiselvi84 · 2023-12-18T20:13:04Z

Looking at the doc for other SDKs, the function matrix is at the top. Eg https://agones.dev/site/docs/guides/client-sdks/rust/#sdk-functionality. Can you follow the same pattern?

I've made changes to NodeJS, C#, and CPP. Could you please confirm that the changes I have made are the correct way for REST?

Kalaiselvi84 · 2023-12-18T20:32:53Z

@igooch Could you please confirm if the following is the correct approach for the REST SDK functionality

| Player           | GetPlayerCapacity               | ✔️          |
| Player           | SetPlayerCapacity               | ✔️          |
| Player           | PlayerConnect                     | ✔️          |
| Player           | GetConnectedPlayers         | ✔️          |
| Player           | IsPlayerConnected              | ✔️          |
| Player           | GetPlayerCount                   | ✔️          |
| Player           | PlayerDisconnect                | ✔️          |
| Counter          | UpdateCounter                   | ✔️          |
| Counter          | GetCounter                      | ✔️          |
| List             | UpdateList                       | ✔️          |
| List             | GetList                             | ✔️          |
| List             | AddListValue                   | ✔️          |
| List             | RemoveListValue            | ✔️          |

agones-bot · 2023-12-18T21:17:55Z

Build Failed 😱

Build Id: 85920a4b-9124-4d86-9cc9-c9aea9375c0e

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

gongmax · 2023-12-18T22:03:20Z

Failed e2e test:

gameserverallocation_test.go:1417: 
VERBOSE:         	Error Trace:	/go/src/agones.dev/agones/test/e2e/gameserverallocation_test.go:1417
VERBOSE:         	Error:      	Not equal: 
VERBOSE:         	            	expected: 100
VERBOSE:         	            	actual  : 99
VERBOSE:         	Test:       	TestGameServerAllocationDuringMultipleAllocationClients
VERBOSE: --- FAIL: TestGameServerAllocationDuringMultipleAllocationClients (41.23s)

gongmax · 2023-12-18T22:23:34Z

site/content/en/docs/Guides/Client SDKs/rest.md

+
+| Area      | Action                                                 | Implemented |
+|-----------|--------------------------------------------------------|-------------|
+| Counters  | GET /v1alpha1/counters/{name}                          | ✔️          |


This part looks good to me. Do we want to add rows for other funcations like the other SDKs?

I have the same question 🙋‍♀️

@igooch Looking forward to your inputs

I'm not entirely sure what Mark envisioned here, but I would start similarly to the "Action" column like we have in https://agones.dev/site/docs/guides/client-sdks/go/. Then below we can include the Path, Method, Body for each action. The actions for Counters areGetCounter UpdateCounter and for Lists GetList UpdateList AddListValue RemoveListValue.

I would also include the existing actions "Ready", "Health" etc. that are named below in this doc. (The generated client API is at agones/test/sdk/restapi/swagger/api_sdk.go if you want to see the method names.)

agones-bot · 2023-12-18T23:03:42Z

Build Succeeded 👏

Build Id: 13ca924e-b844-4d3e-bdec-ce9eaac7974b

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

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

https://e61e1a4-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3548/head:pr_3548 && git checkout pr_3548
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.37.0-dev-e61e1a4-amd64

igooch · 2023-12-19T00:27:35Z

site/content/en/docs/Guides/Client SDKs/rest.md

+
+| Area      | Action                                                 | Implemented |
+|-----------|--------------------------------------------------------|-------------|
+| Counters  | GET /v1alpha1/counters/{name}                          | ✔️          |


I'm not entirely sure what Mark envisioned here, but I would start similarly to the "Action" column like we have in https://agones.dev/site/docs/guides/client-sdks/go/. Then below we can include the Path, Method, Body for each action. The actions for Counters areGetCounter UpdateCounter and for Lists GetList UpdateList AddListValue RemoveListValue.

I would also include the existing actions "Ready", "Health" etc. that are named below in this doc. (The generated client API is at agones/test/sdk/restapi/swagger/api_sdk.go if you want to see the method names.)

igooch · 2023-12-19T00:37:04Z

site/content/en/docs/Guides/Client SDKs/cpp.md

+| Lifecycle       | Allocate            | ✔️          |
+| Lifecycle       | Shutdown            | ✔️          |
+| Configuration   | GameServer          | ✔️          |
+| Configuration   | Watch               | ✔️          |


igooch · 2023-12-19T00:40:34Z

site/content/en/docs/Guides/Client SDKs/cpp.md

+| Player Tracking | GetConnectedPlayers | ✔️          |
+| Player Tracking | GetPlayerCapacity   | ✔️          |
+| Player Tracking | GetPlayerCount      | ✔️          |
+| Player Tracking | IsPlayerConnected   | ✔️          |
+| Player Tracking | PlayerConnect       | ✔️          |
+| Player Tracking | PlayerDisconnect    | ✔️          |
+| Player Tracking | SetPlayerCapacity   | ✔️          |


I don't see this implemented in agones/sdks/cpp/src/agones/sdk.cc

igooch · 2023-12-19T00:41:58Z

site/content/en/docs/Guides/Client SDKs/csharp.md

+| Lifecycle       | Reserve             | ✔️          |
+| Lifecycle       | Allocate            | ✔️          |
+| Lifecycle       | Shutdown            | ✔️          |
+| Configuration   | GameServer          | ✔️          |


igooch · 2023-12-19T00:42:07Z

site/content/en/docs/Guides/Client SDKs/csharp.md

+| Lifecycle       | Allocate            | ✔️          |
+| Lifecycle       | Shutdown            | ✔️          |
+| Configuration   | GameServer          | ✔️          |
+| Configuration   | Watch               | ✔️          |


igooch · 2023-12-19T00:45:11Z

site/content/en/docs/Guides/Client SDKs/nodejs.md

+| Lifecycle       | Reserve             | ✔️          |
+| Lifecycle       | Allocate            | ✔️          |
+| Lifecycle       | Shutdown            | ✔️          |
+| Configuration   | GameServer          | ✔️          |


igooch · 2023-12-19T00:45:22Z

site/content/en/docs/Guides/Client SDKs/nodejs.md

+| Lifecycle       | Allocate            | ✔️          |
+| Lifecycle       | Shutdown            | ✔️          |
+| Configuration   | GameServer          | ✔️          |
+| Configuration   | Watch               | ✔️          |


igooch · 2023-12-19T00:49:49Z

Failed e2e test:

gameserverallocation_test.go:1417: 
VERBOSE:         	Error Trace:	/go/src/agones.dev/agones/test/e2e/gameserverallocation_test.go:1417
VERBOSE:         	Error:      	Not equal: 
VERBOSE:         	            	expected: 100
VERBOSE:         	            	actual  : 99
VERBOSE:         	Test:       	TestGameServerAllocationDuringMultipleAllocationClients
VERBOSE: --- FAIL: [3552](https://github.com/googleforgames/agones/pull/3552) (41.23s)

This is a relatively frequent flake. We should probably open an issue to reduce the flakiness.

Kalaiselvi84 · 2023-12-19T02:01:28Z

@igooch I have completed the review changes as suggested by you

agones-bot · 2023-12-19T03:01:46Z

Build Succeeded 👏

Build Id: ef111394-7133-46ab-87ce-bd795bc1991f

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

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

https://5510b04-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3548/head:pr_3548 && git checkout pr_3548
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.37.0-dev-5510b04-amd64

site/content/en/docs/Guides/Client SDKs/rest.md

gongmax

Only one small comment: can we move these SDK function sections to the top of each doc? similar as the other docs eg: https://agones.dev/site/docs/guides/client-sdks/unreal/#sdk-functionality

Kalaiselvi84 · 2023-12-19T19:31:06Z

Only one small comment: can we move these SDK function sections to the top of each doc?

Relocated it to the top of each file.

agones-bot · 2023-12-19T20:43:38Z

Build Succeeded 👏

Build Id: ec227071-6e03-47d1-91f2-e2f9b2b80155

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

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

https://b003807-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3548/head:pr_3548 && git checkout pr_3548
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.37.0-dev-b003807-amd64

SDK Matrices for NodeJS, C#, CPP, REST

0493526

Kalaiselvi84 requested review from gongmax and igooch December 18, 2023 18:52

github-actions bot added kind/feature New features for Agones size/S labels Dec 18, 2023

gongmax reviewed Dec 18, 2023

View reviewed changes

review changes

e61e1a4

github-actions bot added the size/M label Dec 18, 2023

gongmax reviewed Dec 18, 2023

View reviewed changes

igooch reviewed Dec 19, 2023

View reviewed changes

Review changes

25008e3

Kalaiselvi84 marked this pull request as ready for review December 19, 2023 01:59

Merge branch 'main' into sdk-matrixes

5510b04

gongmax reviewed Dec 19, 2023

View reviewed changes

site/content/en/docs/Guides/Client SDKs/rest.md Outdated Show resolved Hide resolved

gongmax reviewed Dec 19, 2023

View reviewed changes

site/content/en/docs/Guides/Client SDKs/rest.md Outdated Show resolved Hide resolved

Kalaiselvi84 added 2 commits December 19, 2023 18:32

Rest has GetGameServer

fea9e47

Player Tracking included in rest.md

ef49bd1

igooch approved these changes Dec 19, 2023

View reviewed changes

Merge branch 'main' into sdk-matrixes

292cf24

gongmax reviewed Dec 19, 2023

View reviewed changes

Location change

b003807

gongmax approved these changes Dec 19, 2023

View reviewed changes

gongmax enabled auto-merge (squash) December 19, 2023 19:30

gongmax merged commit e20368b into googleforgames:main Dec 19, 2023
4 checks passed

igooch mentioned this pull request Jan 18, 2024

Request for igooch to become Approver #3600

Closed

5 tasks

Kalaiselvi84 deleted the sdk-matrixes branch March 15, 2024 01:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SDK Matrices for NodeJS, C#, CPP, REST #3548

SDK Matrices for NodeJS, C#, CPP, REST #3548

Kalaiselvi84 commented Dec 18, 2023

agones-bot commented Dec 18, 2023

gongmax commented Dec 18, 2023

gongmax left a comment

agones-bot commented Dec 18, 2023

Kalaiselvi84 commented Dec 18, 2023

Kalaiselvi84 commented Dec 18, 2023 •

edited

Loading

agones-bot commented Dec 18, 2023

gongmax commented Dec 18, 2023

gongmax Dec 18, 2023

Kalaiselvi84 Dec 18, 2023

igooch Dec 19, 2023

agones-bot commented Dec 18, 2023

igooch Dec 19, 2023

igooch Dec 19, 2023

igooch Dec 19, 2023 •

edited

Loading

igooch Dec 19, 2023

igooch Dec 19, 2023

igooch Dec 19, 2023

igooch Dec 19, 2023

igooch commented Dec 19, 2023

Kalaiselvi84 commented Dec 19, 2023

agones-bot commented Dec 19, 2023

gongmax left a comment

Kalaiselvi84 commented Dec 19, 2023

agones-bot commented Dec 19, 2023

	\| Configuration \| Watch \| ✔️ \|
	\| Configuration \| WatchGameServer \| ✔️ \|

	\| Configuration \| GameServer \| ✔️ \|
	\| Configuration \| GetGameServer \| ✔️ \|

SDK Matrices for NodeJS, C#, CPP, REST #3548

SDK Matrices for NodeJS, C#, CPP, REST #3548

Conversation

Kalaiselvi84 commented Dec 18, 2023

agones-bot commented Dec 18, 2023

gongmax commented Dec 18, 2023

gongmax left a comment

Choose a reason for hiding this comment

agones-bot commented Dec 18, 2023

Kalaiselvi84 commented Dec 18, 2023

Kalaiselvi84 commented Dec 18, 2023 • edited Loading

agones-bot commented Dec 18, 2023

gongmax commented Dec 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Dec 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

igooch Dec 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

igooch commented Dec 19, 2023

Kalaiselvi84 commented Dec 19, 2023

agones-bot commented Dec 19, 2023

gongmax left a comment

Choose a reason for hiding this comment

Kalaiselvi84 commented Dec 19, 2023

agones-bot commented Dec 19, 2023

Kalaiselvi84 commented Dec 18, 2023 •

edited

Loading

igooch Dec 19, 2023 •

edited

Loading