Tweaks to Client SDK reference #3541

markmandel · 2023-12-14T04:08:32Z

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:

Went through the SDK reference:

Reduced documentation length by setting top level comments or removing what (I think) are redundant statements to make consumption and comprehension easier.
Some of the docs were Go SDK specific. Made it more generic (mostly around return of booleans), as different languages may handle SDK commands slightly differently.
Put player tracking under counter and lists, since counters and lists is the replacement
Added a note on counters and lists replacing player tracking.
Consistency with capitalisation.

Which issue(s) this PR fixes:

Work on #2716

Special notes for your reviewer:

Please let me know if you disagree with any of the changes.

markmandel · 2023-12-14T04:11:22Z

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

+
+This function removes the specific string value string from a List's values. 
+
+An error is returned if the string does not exist in the list.


(not for this release, just food for thought) - depending on feedback, we may want to revisit some of the handling of thing like returning an error if the value is already in the list. I feel like a non-error return of false (or language equivalent) in this scenario is a better developer experience, since we can't do very good cross platform enumeration of different types of errors? 🤔

I'm thinking it would probably make most sense just to move this all over to the specific Go SDK reference, since that's really what these methods are.

We always have a high level reference that is (generally) the basis for all language SDK guides. This makes building language agnostic integration guides easier, and general concept onboarding also easier, since we don't have to duplicate as much language across language SDK references.

Or are you saying, let's just move the existing test over to the Go SDK? (now I read your comment again @igooch )

My point was more - we might want to tweak the Go SDK itself in terms of how it does error handling vs boolean returns, which may impact how the backing gRPC/REST client operates. But like I said - not for this release, just something to think about. I might file an issue for discussion after playing with this more once it's released.

I'm talking about the reference guide modified in this PR, not any test. These methods are specific to the Go client.

These methods are specific to the Go client.

They are also specific to what will be built for the other language SDKs as well. That's why I made them more generic, so they could be used as the conceptual basis for pretty much all language SDKs.

The Go SDK will have it's own generated docs for it's own language specific reference.

For example, we link off to https://pkg.go.dev/agones.dev/agones/sdks/go#Alpha.GetListCapacity (which already got generated in the last release)

agones-bot · 2023-12-14T05:25:11Z

Build Failed 😱

Build Id: fd42e6a0-3bae-4822-b156-f317a3f97bd7

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

markmandel · 2023-12-14T05:48:55Z

site/search/index.html
  Non-OK status: 404 --- site/search/index.html --> https://www.youtube.com/playlist?list=PLhkWKwFGACw2dFpdmwxOyUCzlGP2-n7uF
  Non-OK status: 404 --- site/search/index.html --> https://www.youtube.com/playlist?list=PLhkWKwFGACw2dFpdmwxOyUCzlGP2-n7uF

okay, so that's a blocker. Looking at a fix now.

agones-bot · 2023-12-14T10:31:51Z

Build Succeeded 👏

Build Id: 15edb576-3c13-4506-ba05-165456c10b16

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://89bb821-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3541/head:pr_3541 && git checkout pr_3541
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-89bb821-amd64

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

Went through the SDK reference: * Reduced documentation length by setting top level comments or removing what (I think) are redundant statements to make consumption and comprehension easier. * Some of the docs were Go SDK specific. Made it more generic (mostly around return of booleans), as different languages may handle SDK commands slightly differently. * Put player tracking under counter and lists, since counters and lists is the replacement * Added a note on counters and lists replacing player tracking. * Consistency with capitalisation. Work on googleforgames#2716

agones-bot · 2023-12-14T23:00:22Z

Build Failed 😱

Build Id: f52224d7-304e-4ef6-be01-b72a8df49693

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

markmandel · 2023-12-14T23:36:26Z

generic-1.28 was flaking a bunch

VERBOSE:         	Test:       	TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.989" level=info msg="Length of pod list is 3" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.990" level=info msg="Name of extensions pod 0: agones-extensions-7b5b7ff4bc-mgx9m" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.990" level=info msg="Host IP 10.138.0.102" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.990" level=info msg="Pod IPs [{10.72.11.11}]" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.990" level=info msg="Name of extensions pod 1: agones-extensions-7df9784b69-px9g7" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.990" level=info msg="Host IP 10.138.0.24" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.990" level=info msg="Pod IPs [{10.72.9.38}]" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.990" level=info msg="Name of extensions pod 2: agones-extensions-7df9784b69-v9c4c" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.990" level=info msg="Host IP 10.138.0.80" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.991" level=info msg="Pod IPs [{10.72.5.17}]" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-14 22:54:55.991" level=info msg="Removing one of the Extensions Pods: agones-extensions-7df9784b69-px9g7" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: panic: test timed out after 10m0s
VERBOSE: running tests:
VERBOSE: 	TestGameServerCreationAfterDeletingOneExtensionsPod (10m0s)

agones-bot · 2023-12-15T00:40:16Z

Build Failed 😱

Build Id: 109f00ec-ed32-421e-b9f9-85d13a479bad

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

markmandel · 2023-12-15T01:36:54Z

Okay, this seems like a consistent failure... weird.

VERBOSE:         	Error Trace:	/go/src/agones.dev/agones/test/e2e/extensions/high_availability_test.go:36
VERBOSE:         	Error:      	Received unexpected error:
VERBOSE:         	            	context deadline exceeded
VERBOSE:         	Test:       	TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.398" level=info msg="Length of pod list is 4" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.398" level=info msg="Name of extensions pod 0: agones-extensions-575b9b8b85-hhstl" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.398" level=info msg="Host IP 10.138.0.24" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.398" level=info msg="Pod IPs [{10.72.9.45}]" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.398" level=info msg="Name of extensions pod 1: agones-extensions-5d8d46b879-2ljnr" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.398" level=info msg="Host IP 10.138.0.80" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.399" level=info msg="Pod IPs [{10.72.5.40}]" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.399" level=info msg="Name of extensions pod 2: agones-extensions-5d8d46b879-gwzv8" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.399" level=info msg="Host IP 10.138.0.80" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.399" level=info msg="Pod IPs [{10.72.5.41}]" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.399" level=info msg="Name of extensions pod 3: agones-extensions-7b5b7ff4bc-mgx9m" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.399" level=info msg="Host IP 10.138.0.102" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.399" level=info msg="Pod IPs [{10.72.11.11}]" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: time="2023-12-15 00:34:39.399" level=info msg="Removing one of the Extensions Pods: agones-extensions-5d8d46b879-2ljnr" test=TestGameServerCreationAfterDeletingOneExtensionsPod
VERBOSE: panic: test timed out after 10m0s
VERBOSE: running tests:
VERBOSE: 	TestGameServerCreationAfterDeletingOneExtensionsPod (10m0s)
VERBOSE: 
VERBOSE: goroutine 647 [running]:
VERBOSE: testing.(*M).startAlarm.func1()
VERBOSE: 	/usr/local/go/src/testing/testing.go:2241 +0x219
VERBOSE: created by time.goFunc
VERBOSE: 	/usr/local/go/src/time/sleep.go:176 +0x48

markmandel · 2023-12-15T02:10:53Z

I cleared out the 1.28-generic cluster, let's see if that improves things.

agones-bot · 2023-12-15T03:08:03Z

Build Succeeded 👏

Build Id: 88e81639-1ea3-43a0-8a05-b57a6dd29533

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://0175ea2-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3541/head:pr_3541 && git checkout pr_3541
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-0175ea2-amd64

roberthbailey · 2023-12-15T04:52:31Z

LGTM (but not going to merge yet to give @igooch a chance to respond to your comments).

markmandel requested review from roberthbailey, gongmax and igooch December 14, 2023 04:08

github-actions bot added kind/documentation Documentation for Agones size/M labels Dec 14, 2023

markmandel commented Dec 14, 2023

View reviewed changes

markmandel mentioned this pull request Dec 14, 2023

CountersAndLists in Reference Documentation #3529

Closed

markmandel requested a review from zmerlynn December 14, 2023 06:28

roberthbailey reviewed Dec 14, 2023

View reviewed changes

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

markmandel added 2 commits December 15, 2023 08:41

Review updates.

0175ea2

markmandel force-pushed the docs/update-sdk-reference branch from 89bb821 to 0175ea2 Compare December 14, 2023 22:10

roberthbailey approved these changes Dec 15, 2023

View reviewed changes

igooch approved these changes Dec 15, 2023

View reviewed changes

roberthbailey merged commit 66caba4 into googleforgames:main Dec 15, 2023
4 checks passed

markmandel deleted the docs/update-sdk-reference branch January 3, 2024 04:44

markmandel mentioned this pull request Jan 18, 2024

Flaky: e2e TestGameServerCreationAfterDeletingOneExtensionsPod #3599

Closed

igooch mentioned this pull request Jan 18, 2024

Request for igooch to become Approver #3600

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tweaks to Client SDK reference #3541

Tweaks to Client SDK reference #3541

markmandel commented Dec 14, 2023

markmandel Dec 14, 2023

igooch Dec 14, 2023

markmandel Dec 14, 2023

markmandel Dec 14, 2023

igooch Dec 14, 2023

markmandel Dec 14, 2023

markmandel Dec 14, 2023

agones-bot commented Dec 14, 2023

markmandel commented Dec 14, 2023

agones-bot commented Dec 14, 2023

agones-bot commented Dec 14, 2023

markmandel commented Dec 14, 2023

agones-bot commented Dec 15, 2023

markmandel commented Dec 15, 2023

markmandel commented Dec 15, 2023

agones-bot commented Dec 15, 2023

roberthbailey commented Dec 15, 2023


		This function removes the specific string value string from a List's values.

		An error is returned if the string does not exist in the list.

Tweaks to Client SDK reference #3541

Tweaks to Client SDK reference #3541

Conversation

markmandel commented Dec 14, 2023

markmandel Dec 14, 2023

Choose a reason for hiding this comment

igooch Dec 14, 2023

Choose a reason for hiding this comment

markmandel Dec 14, 2023

Choose a reason for hiding this comment

markmandel Dec 14, 2023

Choose a reason for hiding this comment

igooch Dec 14, 2023

Choose a reason for hiding this comment

markmandel Dec 14, 2023

Choose a reason for hiding this comment

markmandel Dec 14, 2023

Choose a reason for hiding this comment

agones-bot commented Dec 14, 2023

markmandel commented Dec 14, 2023

agones-bot commented Dec 14, 2023

agones-bot commented Dec 14, 2023

markmandel commented Dec 14, 2023

agones-bot commented Dec 15, 2023

markmandel commented Dec 15, 2023

markmandel commented Dec 15, 2023

agones-bot commented Dec 15, 2023

roberthbailey commented Dec 15, 2023