Skip to content
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

JSON Patch in GameServer Controller is Lossy on Int64 #3636

Open
igooch opened this issue Feb 9, 2024 · 1 comment
Open

JSON Patch in GameServer Controller is Lossy on Int64 #3636

igooch opened this issue Feb 9, 2024 · 1 comment
Labels
kind/bug These are bugs.

Comments

@igooch
Copy link
Collaborator

igooch commented Feb 9, 2024

TL;DR:
JSON does not support Int64 well. The current recommendation is that anyone using the count or capacity values should avoid using extremely large numbers.

Issue with setting count or capacity for Counter to max(int64):

When the Counter capacity or count are set to max(int64) in the game server spec and running kubectl create -f fleet.yaml we get an error:
spec.template.spec.counters.sessions.capacity: Invalid value: "number": spec.template.spec.counters.sessions.capacity in body must be of type integer: "number"

When the Counter capacity or count in the game server spec are close to, but not at, max(int64) kubectl create does not error. However, when checking the details of the game server with kubectl describe the values are truncated:

spec:
  template:
    spec:
      counters:
        sessions:
          count: 8611686018427387904
          capacity: 8611686018427387904

becomes

Spec:
  Template:
    Spec:
      Counters:
        Sessions:
          Capacity:  8611686018427388000
          Count:     8611686018427388000

Debugging:

@zmerlynn root-caused the issue #3608, and found that the source issue is with jsonpatch translating values to scientific notation. A different repo ran into the same error and has a longer description of the issue evanphx/json-patch#189. We're unable to switch to this repo because the fixed method CreateMergePatch just gives back bytes, but in tests, etc. we use the jsonpatch structures. This will likely need to be an upstream fix in gomodules/jsonpatch or kubernetes-sigs/json. The takeaway is that JSON does not support int64 well, and if the controller is having this many issues there are likely other issues that would crop up elsewhere in the code, and other languages would have yet another set of issues.

@igooch igooch added the kind/bug These are bugs. label Feb 9, 2024
markmandel added a commit to markmandel/agones that referenced this issue Feb 9, 2024
It's better we're on the same project that controller-runtime uses so we
can take advantage of any upstream security and bugfixes that may occur
- or have occurred already!

Work on googleforgames#3636 - since if that issue gets fixed, it will get fixed here.

Also, it ws a fun little fix to work on 😃
zmerlynn added a commit that referenced this issue Feb 10, 2024
It's better we're on the same project that controller-runtime uses so we
can take advantage of any upstream security and bugfixes that may occur
- or have occurred already!

Work on #3636 - since if that issue gets fixed, it will get fixed here.

Also, it ws a fun little fix to work on 😃

Co-authored-by: Zach Loafman <zml@google.com>
@zmerlynn
Copy link
Collaborator

Filed gomodules/jsonpatch#39

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug These are bugs.
Projects
None yet
Development

No branches or pull requests

2 participants