-
Notifications
You must be signed in to change notification settings - Fork 801
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
SDK Matrices for NodeJS, C#, CPP, REST #3548
Conversation
Build Failed 😱 Build Id: 7daaf50b-1995-4d8b-b06d-0d10c8bb6c47 To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
one failed unit test
Retrying... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
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): To install this version:
|
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? |
@igooch Could you please confirm if the following is the correct approach for the REST SDK functionality
|
Build Failed 😱 Build Id: 85920a4b-9124-4d86-9cc9-c9aea9375c0e To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
Failed e2e test:
|
|
||
| Area | Action | Implemented | | ||
|-----------|--------------------------------------------------------|-------------| | ||
| Counters | GET /v1alpha1/counters/{name} | ✔️ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This part looks good to me. Do we want to add rows for other funcations like the other SDKs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have the same question 🙋♀️
@igooch Looking forward to your inputs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.)
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): To install this version:
|
|
||
| Area | Action | Implemented | | ||
|-----------|--------------------------------------------------------|-------------| | ||
| Counters | GET /v1alpha1/counters/{name} | ✔️ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.)
| Lifecycle | Allocate | ✔️ | | ||
| Lifecycle | Shutdown | ✔️ | | ||
| Configuration | GameServer | ✔️ | | ||
| Configuration | Watch | ✔️ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Configuration | Watch | ✔️ | | |
| Configuration | WatchGameServer | ✔️ | |
| Player Tracking | GetConnectedPlayers | ✔️ | | ||
| Player Tracking | GetPlayerCapacity | ✔️ | | ||
| Player Tracking | GetPlayerCount | ✔️ | | ||
| Player Tracking | IsPlayerConnected | ✔️ | | ||
| Player Tracking | PlayerConnect | ✔️ | | ||
| Player Tracking | PlayerDisconnect | ✔️ | | ||
| Player Tracking | SetPlayerCapacity | ✔️ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see this implemented in agones/sdks/cpp/src/agones/sdk.cc
| Lifecycle | Reserve | ✔️ | | ||
| Lifecycle | Allocate | ✔️ | | ||
| Lifecycle | Shutdown | ✔️ | | ||
| Configuration | GameServer | ✔️ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Configuration | GameServer | ✔️ | | |
| Configuration | GetGameServer | ✔️ | | |
| Lifecycle | Allocate | ✔️ | | ||
| Lifecycle | Shutdown | ✔️ | | ||
| Configuration | GameServer | ✔️ | | ||
| Configuration | Watch | ✔️ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Configuration | Watch | ✔️ | | |
| Configuration | WatchGameServer | ✔️ | | |
| Lifecycle | Reserve | ✔️ | | ||
| Lifecycle | Allocate | ✔️ | | ||
| Lifecycle | Shutdown | ✔️ | | ||
| Configuration | GameServer | ✔️ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Configuration | GameServer | ✔️ | | |
| Configuration | GetGameServer | ✔️ | |
| Lifecycle | Allocate | ✔️ | | ||
| Lifecycle | Shutdown | ✔️ | | ||
| Configuration | GameServer | ✔️ | | ||
| Configuration | Watch | ✔️ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Configuration | Watch | ✔️ | | |
| Configuration | WatchGameServer | ✔️ | |
This is a relatively frequent flake. We should probably open an issue to reduce the flakiness. |
@igooch I have completed the review changes as suggested by you |
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): To install this version:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
Relocated it to the top of each file. |
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): To install this version:
|
What type of PR is this?
/kind feature
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: