refactor simple game server #3817

ashutosji · 2024-05-10T09:25:24Z

What type of PR is this? This is a refactor of existing code of simple game server present in examples folder.

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: #3813

Closes #3813

Special notes for your reviewer:

github-actions · 2024-05-10T09:25:39Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-05-10T10:28:50Z

Build Succeeded 👏

Build Id: 72700498-8b76-4a75-8bea-5879ed4cd3a9

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3817/head:pr_3817 && git checkout pr_3817
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-8b83ca3-amd64

markmandel

Approach looks good! Some nits, and some other ideas to try.

markmandel · 2024-05-13T22:43:32Z

examples/simple-game-server/helper.go

@@ -0,0 +1,331 @@
+package main


Apache licence header please.

examples/simple-game-server/response-handler.go

markmandel · 2024-05-13T23:05:17Z

examples/simple-game-server/helper.go

+func ready(s *sdk.SDK) {
+	err := s.Ready()
+	if err != nil {
+		log.Fatalf("Could not send ready message")
+	}
+}


So I am noting that we have a pattern that looks like the above quite a bit - execute a function on the SDK, if it fails, log.Fatalf(...)

Not 100% sure how useful this would be - as it may only apply in a few places, but something like:

func runSDK(f func() err, failMsg string) { if err := f(); err != nil { log.Fatalf(failMsg + ": %v", err) } }

Then this function could pretty much go away and you could do inline in handleReady

func handleReady(s *sdk.SDK, parts []string, _ ...context.CancelFunc) (response string, addACK bool, responseError error) { runSDK(func() err { return s.Ready() }, "Could not send ready message") }

Since it's a closure, it could also handle anything taking in a series of arguments.

Where it goes fall over is if a SDK function returns several return values -- so it may not be worth it. But figured I'd show you my general idea, and see if it made sense -- save writing two functions for each command.

So I am noting that we have a pattern that looks like the above quite a bit - execute a function on the SDK, if it fails, log.Fatalf(...)

Not 100% sure how useful this would be - as it may only apply in a few places, but something like:

func runSDK(f func() err, failMsg string) { if err := f(); err != nil { log.Fatalf(failMsg + ": %v", err) } }

Then this function could pretty much go away and you could do inline in handleReady

func handleReady(s *sdk.SDK, parts []string, _ ...context.CancelFunc) (response string, addACK bool, responseError error) { runSDK(func() err { return s.Ready() }, "Could not send ready message") }

Since it's a closure, it could also handle anything taking in a series of arguments.

Where it goes fall over is if a SDK function returns several return values -- so it may not be worth it. But figured I'd show you my general idea, and see if it made sense -- save writing two functions for each command.

Ahan! I got it. I have added all the sdk functions inside the handlers.

markmandel · 2024-05-13T23:05:37Z

examples/simple-game-server/response-handler.go

@@ -0,0 +1,371 @@
+package main


rename suggestion: handlers.go

markmandel · 2024-05-13T23:07:25Z

examples/simple-game-server/helper.go

@@ -0,0 +1,331 @@
+package main


Rename suggestions : sdk.go (don't love it) - but helpers.go is a bit ambiguous. sdk.go gives some idea that this is where the sdk gets called.

Either that or pull it all into handers.go and put the SDK command under each handler? (or if need be, make it inline?)

Rename suggestions : sdk.go (don't love it) - but helpers.go is a bit ambiguous. sdk.go gives some idea that this is where the sdk gets called.

Either that or pull it all into handers.go and put the SDK command under each handler? (or if need be, make it inline?)

I have pulled everything inside handlers.go. sdk.go isn't required.
Thank you so much for your guidance.

github-actions · 2024-05-14T11:00:32Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-05-14T12:33:58Z

Build Succeeded 👏

Build Id: c54e02bb-849e-45cd-83ba-9885bf4fa113

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3817/head:pr_3817 && git checkout pr_3817
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-7a03c71-amd64

markmandel

Looks good!

Will need an increment on the version number:

agones/examples/simple-game-server/Makefile

Line 41 in ca58471

version := 0.32

Will also need to update all the references to simple-game-server - but may want to test locally with some e2e tests before updating everything as we'll need to push a new version to prod.

markmandel · 2024-05-16T23:03:04Z

examples/simple-game-server/handlers.go

@@ -0,0 +1,581 @@
+// Copyright 2020 Google LLC All Rights Reserved.


Suggested change

// Copyright 2020 Google LLC All Rights Reserved.

// Copyright 2024 Google LLC All Rights Reserved.

github-actions · 2024-05-21T09:18:18Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

ashutosji · 2024-05-21T09:32:03Z

Looks good!

Will need an increment on the version number:

agones/examples/simple-game-server/Makefile

Line 41 in ca58471

version := 0.32

Will also need to update all the references to simple-game-server - but may want to test locally with some e2e tests before updating everything as we'll need to push a new version to prod.

I had tested few functionalities mentioned in this file: https://github.com/googleforgames/agones/blob/main/test/e2e/gameserver_test.go#L717.
Also, I had ran the command mentioned here: https://github.com/googleforgames/agones/blob/main/build/README.md#make-test-e2e and https://github.com/googleforgames/agones/blob/main/build/README.md#make-test-go.

Everything works perfectly to me. I was communicated with gameserver (https://agones.dev/site/docs/getting-started/create-gameserver/#3-connect-to-the-gameserver) the response was as expected.

Please, let me know what else i am missing for e2e test.

agones-bot · 2024-05-21T10:08:42Z

Build Failed 😱

Build Id: 2eb3c057-1ad5-4c69-9e20-40a830f1b884

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

github-actions · 2024-05-21T10:52:44Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-05-21T11:44:08Z

Build Failed 😱

Build Id: bdcd983b-76c0-4aba-be39-cbf32599be5f

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

ashutosji · 2024-05-21T15:20:04Z

Hi @markmandel,

Step #1 - "e2e-feature-gates":     framework.go:346: 
Step #1 - "e2e-feature-gates":         	Error Trace:	/go/src/agones.dev/agones/test/e2e/framework/framework.go:346
Step #1 - "e2e-feature-gates":         	            				/go/src/agones.dev/agones/test/e2e/allocator_test.go:77
Step #1 - "e2e-feature-gates":         	Error:      	Received unexpected error:
Step #1 - "e2e-feature-gates":         	            	context deadline exceeded
Step #1 - "e2e-feature-gates":         	Test:       	TestAllocatorWithDeprecatedRequired
Step #1 - "e2e-feature-gates":         	Messages:   	error waiting for fleet condition on fleet: simple-fleet-1.052xsd
Step #1 - "e2e-feature-gates": --- FAIL: TestAllocatorWithDeprecatedRequired (302.54s)
Step #1 - "e2e-feature-gates": FAIL test/e2e.TestAllocatorWithDeprecatedRequired (302.54s)

Could you please guide why this is failing. There are other functions also failing in allocator_test.go file.
I am not getting why it is failing.

igooch · 2024-05-21T19:56:55Z

Could you please guide why this is failing. There are other functions also failing in allocator_test.go file. I am not getting why it is failing.

It's possible it's failing because the simple game server image 0.33 is not in the Agones artifact registry yet. You can test if that's the issue locally by pushing the simple game server image to your dev project's artifact registry https://github.com/googleforgames/agones/blob/main/examples/simple-game-server/Makefile and temporarily changing the image to your repo image

agones/test/e2e/framework/framework.go

Line 153 in bff72b1

    
           viper.SetDefault(gsimageFlag, "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.32")

and running the tests on your cluster.

markmandel · 2024-05-24T00:28:31Z

As part of this PR, try out the approach(es) in #3836 and see if they work for you 👍🏻

github-actions · 2024-05-31T10:27:58Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-05-31T10:31:14Z

Build Failed 😱

Build Id: ded8d76c-7d0f-4290-bf8e-6b840b5f906b

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

github-actions · 2024-05-31T10:45:54Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-05-31T11:30:18Z

Build Failed 😱

Build Id: 93ea63f6-853d-4104-a5af-6fa11f8b1d70

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

markmandel · 2024-05-31T21:36:52Z

build/Makefile

@@ -64,7 +64,7 @@ KIND_PROFILE ?= agones
 KIND_CONTAINER_NAME=$(KIND_PROFILE)-control-plane

 # Game Server image to use while doing end-to-end tests
-GS_TEST_IMAGE ?= us-docker.pkg.dev/agones-images/examples/simple-game-server:0.32
+GS_TEST_IMAGE ?= us-central1-docker.pkg.dev/agones-ashutoshnsingh/example/simple-game-server:0.33-dev-linux-amd64


I expect this won't work, since the agones-images project doesn't have access to your artifact registry.

You could make it public if yo u desired though 😄 at least temporarily.

Thanks a lot @markmandel. It worked perfectly.

github-actions · 2024-06-03T10:52:10Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-06-03T11:49:15Z

Build Failed 😱

Build Id: cbe7023a-7c96-4571-870d-a23ed4285820

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

github-actions · 2024-06-11T05:54:08Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-06-11T06:36:50Z

Build Failed 😱

Build Id: 30608748-02a4-49c9-8040-fc7115fbe729

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

github-actions · 2024-06-11T11:47:50Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-06-11T12:47:41Z

Build Succeeded 👏

Build Id: 254786fa-3d32-4495-8ee8-ae24ac80f490

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3817/head:pr_3817 && git checkout pr_3817
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.42.0-dev-5a1d70b-amd64

markmandel

Looks great! Let's get the new image up to prod and switch over to using it 👍🏻

markmandel · 2024-06-11T22:57:11Z

test/e2e/framework/framework.go

@@ -799,7 +799,7 @@ func (f *Framework) DefaultGameServer(namespace string) *agonesv1.GameServer {
 					Containers: []corev1.Container{{
 						Name:            "game-server",
 						Image:           f.GameServerImage,
-						ImagePullPolicy: corev1.PullIfNotPresent,
+						ImagePullPolicy: corev1.PullAlways,


Before we close off this PR, let's move this back to PullIfNotPresent

Done! Added the new image to prod. Also updated the new image in all the files. Could you please review it and merge it?

github-actions · 2024-06-17T10:59:24Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-06-17T11:59:52Z

Build Succeeded 👏

Build Id: a494d89a-3aca-44ed-a13d-453fef3833a1

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3817/head:pr_3817 && git checkout pr_3817
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.42.0-dev-1614bf0-amd64

igooch

LGTM

github-actions · 2024-06-25T01:34:34Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2024-06-25T02:35:40Z

Build Succeeded 👏

Build Id: 5f5f5998-b3b5-4c2f-9152-491a909ffe58

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3817/head:pr_3817 && git checkout pr_3817
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.42.0-dev-8bec16b-amd64

github-actions bot added kind/cleanup Refactoring code, fixing up documentation, etc size/XL labels May 10, 2024

ashutosji requested review from markmandel and igooch May 10, 2024 09:25

markmandel reviewed May 13, 2024

View reviewed changes

ashutosji force-pushed the refactor-simple-game-server branch from 8b83ca3 to 7a03c71 Compare May 14, 2024 11:00

markmandel reviewed May 16, 2024

View reviewed changes

ashutosji force-pushed the refactor-simple-game-server branch from 7a03c71 to 253638e Compare May 21, 2024 09:18

ashutosji force-pushed the refactor-simple-game-server branch from 253638e to 7c8810f Compare May 21, 2024 10:52

ashutosji force-pushed the refactor-simple-game-server branch from 7c8810f to 636f807 Compare May 31, 2024 10:27

ashutosji force-pushed the refactor-simple-game-server branch from 636f807 to 3ee108f Compare May 31, 2024 10:45

markmandel reviewed May 31, 2024

View reviewed changes

ashutosji force-pushed the refactor-simple-game-server branch from 3ee108f to e2f17f4 Compare June 3, 2024 10:51

ashutosji force-pushed the refactor-simple-game-server branch from e2f17f4 to 42c7843 Compare June 11, 2024 05:53

markmandel reviewed Jun 11, 2024

View reviewed changes

ashutosji added 7 commits June 17, 2024 10:21

refactor simple game server

3aff770

added the suggested changes

77292f8

updated the version and added the sugested change

5b5a5d7

testing

bf736e4

testing-1

83c0c35

testing-2

bc317f4

final refactored code

1614bf0

ashutosji force-pushed the refactor-simple-game-server branch from 5a1d70b to 1614bf0 Compare June 17, 2024 10:59

ashutosji marked this pull request as ready for review June 18, 2024 12:27

igooch approved these changes Jun 21, 2024

View reviewed changes

markmandel enabled auto-merge (squash) June 25, 2024 00:33

Merge branch 'main' into refactor-simple-game-server

8bec16b

markmandel merged commit d8689db into googleforgames:main Jun 25, 2024
3 of 4 checks passed

		@@ -0,0 +1,581 @@
		// Copyright 2020 Google LLC All Rights Reserved.

	// Copyright 2020 Google LLC All Rights Reserved.
	// Copyright 2024 Google LLC All Rights Reserved.

refactor simple game server #3817

refactor simple game server #3817

Conversation

ashutosji commented May 10, 2024

github-actions bot commented May 10, 2024

agones-bot commented May 10, 2024

markmandel left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 14, 2024

agones-bot commented May 14, 2024

markmandel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 21, 2024

ashutosji commented May 21, 2024

agones-bot commented May 21, 2024

github-actions bot commented May 21, 2024

agones-bot commented May 21, 2024

ashutosji commented May 21, 2024

igooch commented May 21, 2024 • edited Loading

markmandel commented May 24, 2024

github-actions bot commented May 31, 2024

agones-bot commented May 31, 2024

github-actions bot commented May 31, 2024

agones-bot commented May 31, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jun 3, 2024

agones-bot commented Jun 3, 2024

github-actions bot commented Jun 11, 2024

agones-bot commented Jun 11, 2024

github-actions bot commented Jun 11, 2024

agones-bot commented Jun 11, 2024

markmandel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jun 17, 2024

agones-bot commented Jun 17, 2024

igooch left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 25, 2024

agones-bot commented Jun 25, 2024

igooch commented May 21, 2024 •

edited

Loading