diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 14700a2..cda804b 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -1,38 +1,37 @@ -name-template: '$RESOLVED_VERSION' -tag-template: '$RESOLVED_VERSION' +--- +name-template: "$RESOLVED_VERSION" +tag-template: "$RESOLVED_VERSION" prerelease: true template: | # What's Changed $CHANGES categories: - - title: Breaking - label: breaking - - title: New - label: enhancement - - title: Bug Fixes - label: bug - - title: Maintenance - label: maintenance - - title: Documentation - label: documentation - - title: Dependency Updates - label: dependencies - +- title: "Breaking" + label: "breaking" +- title: "New" + label: "enhancement" +- title: "Bug Fixes" + label: "bug" +- title: "Maintenance" + label: "maintenance" +- title: "Documentation" + label: "documentation" +- title: "Dependency Updates" + label: "dependencies" version-resolver: major: labels: - - breaking + - "breaking" minor: labels: - - enhancement + - "enhancement" patch: labels: - - bug - - maintenance - - documentation - - dependencies - - security - + - "bug" + - "maintenance" + - "documentation" + - "dependencies" + - "security" exclude-labels: - - skip-changelog +- "skip-changelog" diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4411561..1a7bcea 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,37 +1,31 @@ -name: Build - -on: +--- +name: "Build" +"on": pull_request: - branches: [ master ] - + branches: + - "master" jobs: build: - name: Build - runs-on: ubuntu-latest + name: "Build" + runs-on: "ubuntu-latest" steps: - - uses: actions/checkout@v4 - - - uses: actions/setup-java@v4 - with: - distribution: 'adopt' - java-version: '8' - - - uses: arduino/setup-protoc@v1 - - - uses: actions/cache@v4 - with: - path: ~/.gradle/caches - key: ${{ runner.os }}-gradle-cache-${{ hashFiles('**/*.gradle.kts') }} - restore-keys: | - ${{ runner.os }}-gradle- - - - uses: actions/cache@v4 - with: - path: ~/.gradle/wrapper - key: ${{ runner.os }}-gradle-wrapper-${{ hashFiles('**/gradle-wrapper.properties') }} - restore-keys: | - ${{ runner.os }}-gradlew- - - - run: | - chmod +x gradlew - ./gradlew build + - uses: "actions/checkout@v4" + - uses: "actions/setup-java@v4" + with: + distribution: "adopt" + java-version: "11" + - uses: "actions/cache@v4" + with: + path: "~/.gradle/caches" + key: "${{ runner.os }}-gradle-cache-${{ hashFiles('**/*.gradle.kts') }}" + restore-keys: | + ${{ runner.os }}-gradle- + - uses: "actions/cache@v4" + with: + path: "~/.gradle/wrapper" + key: "${{ runner.os }}-gradle-wrapper-${{ hashFiles('**/gradle-wrapper.properties') }}" + restore-keys: | + ${{ runner.os }}-gradlew- + - run: | + chmod +x gradlew + ./gradlew build diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index fef8afa..1e80163 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -1,16 +1,16 @@ -name: Update Changelog - -on: +--- +name: "Update Changelog" +"on": push: - branches: [ master ] - + branches: + - "master" jobs: changelog: - name: Update Changelog - runs-on: ubuntu-latest - if: ${{ !contains(github.event.head_commit.message, 'skip-snapshot') }} + name: "Update Changelog" + runs-on: "ubuntu-latest" + if: "${{ !contains(github.event.head_commit.message, 'skip-snapshot') }}" steps: - - uses: release-drafter/release-drafter@master - id: release - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - uses: "release-drafter/release-drafter@master" + id: "release" + env: + GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..0e5a0f7 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,32 @@ +--- +name: "Release" +"on": + release: + types: + - "released" +jobs: + build: + name: "Release" + runs-on: "ubuntu-latest" + steps: + - uses: "actions/checkout@v4" + - uses: "actions/setup-java@v4" + with: + distribution: "adopt" + java-version: "11" + - uses: "actions/cache@v4" + with: + path: "~/.gradle/caches" + key: "${{ runner.os }}-gradle-cache-${{ hashFiles('**/*.gradle.kts') }}" + restore-keys: | + ${{ runner.os }}-gradle- + - uses: "actions/cache@v4" + with: + path: "~/.gradle/wrapper" + key: "${{ runner.os }}-gradle-wrapper-${{ hashFiles('**/gradle-wrapper.properties') }}" + restore-keys: | + ${{ runner.os }}-gradlew- + - run: | + [[ "${{ github.event.release.tag_name }}" =~ ^[0-9]+(\.[0-9]+)*$ ]] || exit -1 + chmod +x gradlew + ./gradlew -Psign-required=true publish -Pversion="${{ github.event.release.tag_name }}" -PmavenCentralUsername="${{ secrets.MAVEN_CENTRAL_USERNAME }}" -PmavenCentralPassword="${{ secrets.MAVEN_CENTRAL_PASSWORD }}" -PsigningInMemoryKey="${{ secrets.GPG_PRIVATE_KEY_ARMORED }}" -PsigningInMemoryKeyPassword="${{ secrets.GPG_PASSPHRASE }}" diff --git a/.run/build.run.xml b/.run/build.run.xml deleted file mode 100644 index 87e14e1..0000000 --- a/.run/build.run.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - true - true - false - false - - - \ No newline at end of file diff --git a/README.md b/README.md index 1d040bd..9c9ef01 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ # agones4j -[![](https://jitpack.io/v/infumia/agones4j.svg)](https://jitpack.io/#infumia/agones4j) +[![Maven Central Version](https://img.shields.io/maven-central/v/net.infumia/agones4j)](https://central.sonatype.com/artifact/net.infumia/agones4j/) ## How to Use (Developers) ### Code ```groovy repositories { - maven("https://jitpack.io/") + mavenCentral() } dependencies { - // https://mvnrepository.com/artifact/io.grpc/grpc-stub/latest - implementation "io.grpc:grpc-stub:1.47.0" - implementation "io.grpc:grpc-protobuf:1.47.0" - implementation "io.grpc:grpc-netty:1.47.0" - implementation "com.github.infumia:agones4j:VERSION" + // Base module + implementation "net.infumia:agones4j:VERSION" + // Required, https://mvnrepository.com/artifact/io.grpc/grpc-stub/ + implementation "io.grpc:grpc-stub:1.64.0" + implementation "io.grpc:grpc-protobuf:1.64.0" + // Required, https://github.com/grpc/grpc-java/blob/master/gradle/libs.versions.toml#L46/ + implementation "org.apache.tomcat:annotations-api:1.64.0" } ``` ```java diff --git a/build.gradle.kts b/build.gradle.kts index 5996525..11afccd 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,118 +1,18 @@ -import com.google.protobuf.gradle.id +import net.infumia.gradle.applyProtobuf +import net.infumia.gradle.publish +import net.infumia.gradle.spotless -plugins { - java - `java-library` - `maven-publish` - alias(libs.plugins.protobuf) -} - -repositories { - mavenCentral() -} - -dependencies { - compileOnlyApi(libs.protobuf) - compileOnlyApi(libs.grpc.protobuf) - compileOnlyApi(libs.grpc.stub) - compileOnlyApi(libs.annotationsapi) -} - -sourceSets { - main { - java { - srcDirs("build/generated/source/proto/main/java") - } - resources { - srcDir("src/main/proto") - } - } -} +plugins { java } -protobuf { - protoc { artifact = libs.protoc.get().toString() } +publish() - plugins { - id("grpc") { - artifact = "io.grpc:protoc-gen-grpc-java:${libs.versions.grpc.get()}" - } - } +applyProtobuf() - generateProtoTasks { - all().forEach { - it.plugins { - id("grpc") { - outputSubDir = "java" - } - } - } - } -} - -tasks { - compileJava { - options.encoding = Charsets.UTF_8.name() - } - - javadoc { - options.encoding = Charsets.UTF_8.name() - (options as StandardJavadocDocletOptions).tags("todo") - exclude("**/allocation/**") - exclude("**/agones/**") - exclude("**/com/google/api/**") - exclude("**/grpc/**") - } - - val javadocJar by creating(Jar::class) { - dependsOn("javadoc") - archiveClassifier.set("javadoc") - from(javadoc) - } +spotless() - val sourcesJar by creating(Jar::class) { - dependsOn("classes") - archiveClassifier.set("sources") - duplicatesStrategy = DuplicatesStrategy.INCLUDE - from(sourceSets["main"].allSource) - } - - processResources { - duplicatesStrategy = DuplicatesStrategy.EXCLUDE - } -} - -publishing { - publications { - create("mavenJava") { - groupId = project.group.toString() - artifactId = "agones4j" - version = project.version.toString() - from(components["java"]) - artifact(tasks["sourcesJar"]) - artifact(tasks["javadocJar"]) - pom { - name.set("Agones4J") - description.set("Java wrapper for Agones client SDK.") - url.set("https://infumia.com.tr/") - licenses { - license { - name.set("MIT License") - url.set("https://mit-license.org/license.txt") - } - } - developers { - developer { - id.set("portlek") - name.set("Hasan Demirtaş") - email.set("utsukushihito@outlook.com") - } - } - scm { - connection.set("scm:git:git://github.com/infumia/agones4j.git") - developerConnection.set("scm:git:ssh://github.com/infumia/agones4j.git") - url.set("https://github.com/infumia/agones4j") - } - } - } - } +dependencies { + compileOnly(libs.protobuf) + compileOnly(libs.grpc.protobuf) + compileOnly(libs.grpc.stub) + compileOnly(libs.annotationsapi) } diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts new file mode 100644 index 0000000..0467ad8 --- /dev/null +++ b/buildSrc/build.gradle.kts @@ -0,0 +1,18 @@ +plugins { `kotlin-dsl` } + +repositories { + mavenCentral() + gradlePluginPortal() +} + +dependencies { + // TODO: portlek, remove once + // https://github.com/gradle/gradle/issues/15383#issuecomment-779893192 is fixed + implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location)) + + implementation(libs.nexus.plugin) + implementation(libs.spotless.plugin) + implementation(libs.protobuf.plugin) +} + +kotlin { jvmToolchain(11) } diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts new file mode 100644 index 0000000..65a9695 --- /dev/null +++ b/buildSrc/settings.gradle.kts @@ -0,0 +1,3 @@ +dependencyResolutionManagement { + versionCatalogs { create("libs") { from(files("../gradle/libs.versions.toml")) } } +} diff --git a/buildSrc/src/main/kotlin/net/infumia/gradle/common.kt b/buildSrc/src/main/kotlin/net/infumia/gradle/common.kt new file mode 100644 index 0000000..7aff6b9 --- /dev/null +++ b/buildSrc/src/main/kotlin/net/infumia/gradle/common.kt @@ -0,0 +1,41 @@ +package net.infumia.gradle + +import org.gradle.api.Project +import org.gradle.api.file.DuplicatesStrategy +import org.gradle.api.plugins.JavaPlugin +import org.gradle.api.plugins.JavaPluginExtension +import org.gradle.api.tasks.bundling.Jar +import org.gradle.jvm.toolchain.JavaLanguageVersion +import org.gradle.kotlin.dsl.* +import org.gradle.language.jvm.tasks.ProcessResources + +fun Project.applyCommon(javaVersion: Int = 8, sources: Boolean = true, javadoc: Boolean = true) { + apply() + + repositories.mavenCentral() + + extensions.configure { + toolchain { languageVersion = JavaLanguageVersion.of(javaVersion) } + } + + if (javadoc) { + val javadocJar by + tasks.creating(Jar::class) { + dependsOn("javadoc") + archiveClassifier.set("javadoc") + from(javadoc) + } + } + + if (sources) { + val sourceSets = extensions.getByType().sourceSets + val sourcesJar by + tasks.creating(Jar::class) { + dependsOn("classes") + archiveClassifier.set("sources") + from(sourceSets["main"].allSource) + } + } + + tasks { withType { duplicatesStrategy = DuplicatesStrategy.EXCLUDE } } +} diff --git a/buildSrc/src/main/kotlin/net/infumia/gradle/protobuf.kt b/buildSrc/src/main/kotlin/net/infumia/gradle/protobuf.kt new file mode 100644 index 0000000..958e4cb --- /dev/null +++ b/buildSrc/src/main/kotlin/net/infumia/gradle/protobuf.kt @@ -0,0 +1,43 @@ +package net.infumia.gradle + +import com.google.protobuf.gradle.ProtobufExtension +import com.google.protobuf.gradle.ProtobufPlugin +import com.google.protobuf.gradle.id +import org.gradle.accessors.dm.LibrariesForLibs +import org.gradle.api.Project +import org.gradle.api.plugins.JavaPluginExtension +import org.gradle.api.tasks.javadoc.Javadoc +import org.gradle.kotlin.dsl.* + +fun Project.applyProtobuf() { + val libs = project.rootProject.the() + + apply() + + extensions.getByType().sourceSets { + named("main") { + java { srcDirs("build/generated/source/proto/main/java") } + + resources { srcDir("src/main/proto") } + } + } + + extensions.configure { + protoc { artifact = libs.protoc.get().toString() } + + plugins { + id("grpc") { artifact = "io.grpc:protoc-gen-grpc-java:${libs.versions.grpc.get()}" } + } + + generateProtoTasks { all().forEach { it.plugins { id("grpc") { outputSubDir = "java" } } } } + } + + tasks { + withType { + exclude("**/allocation/**") + exclude("**/agones/**") + exclude("**/com/google/api/**") + exclude("**/grpc/**") + } + } +} diff --git a/buildSrc/src/main/kotlin/net/infumia/gradle/publish.kt b/buildSrc/src/main/kotlin/net/infumia/gradle/publish.kt new file mode 100644 index 0000000..d0241a8 --- /dev/null +++ b/buildSrc/src/main/kotlin/net/infumia/gradle/publish.kt @@ -0,0 +1,52 @@ +package net.infumia.gradle + +import com.vanniktech.maven.publish.MavenPublishBaseExtension +import com.vanniktech.maven.publish.MavenPublishPlugin +import com.vanniktech.maven.publish.SonatypeHost +import org.gradle.api.Project +import org.gradle.kotlin.dsl.* + +fun Project.publish( + moduleName: String? = null, + javaVersion: Int = 8, + sources: Boolean = true, + javadoc: Boolean = true +) { + applyCommon(javaVersion, sources, javadoc) + apply() + + val projectName = "agones4j${if (moduleName == null) "" else "-$moduleName"}" + val signRequired = project.hasProperty("sign-required") + + extensions.configure { + coordinates(project.group.toString(), projectName, project.version.toString()) + publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL, true) + if (signRequired) { + signAllPublications() + } + + pom { + name.set("Agones4J") + description.set("Java wrapper for Agones client SDK.") + url.set("https://infumia.com.tr/") + licenses { + license { + name.set("MIT License") + url.set("https://mit-license.org/license.txt") + } + } + developers { + developer { + id.set("portlek") + name.set("Hasan Demirtaş") + email.set("utsukushihito@outlook.com") + } + } + scm { + connection.set("scm:git:git://github.com/infumia/agones4j.git") + developerConnection.set("scm:git:ssh://github.com/infumia/agones4j.git") + url.set("https://github.com/infumia/agones4j") + } + } + } +} diff --git a/buildSrc/src/main/kotlin/net/infumia/gradle/spotless.kt b/buildSrc/src/main/kotlin/net/infumia/gradle/spotless.kt new file mode 100644 index 0000000..cdb2e16 --- /dev/null +++ b/buildSrc/src/main/kotlin/net/infumia/gradle/spotless.kt @@ -0,0 +1,87 @@ +package net.infumia.gradle + +import com.diffplug.gradle.spotless.SpotlessExtension +import com.diffplug.gradle.spotless.SpotlessPlugin +import org.gradle.api.Project +import org.gradle.kotlin.dsl.* + +fun Project.spotless() { + repositories.mavenCentral() + + apply() + + extensions.configure { + isEnforceCheck = false + lineEndings = com.diffplug.spotless.LineEnding.UNIX + + val prettierConfig = + mapOf( + "prettier" to "3.3.2", + "prettier-plugin-java" to "2.6.0", + "prettier-plugin-toml" to "2.0.1", + ) + + yaml { + target(".github/**/*.yml") + endWithNewline() + trimTrailingWhitespace() + jackson().yamlFeature("LITERAL_BLOCK_STYLE", true).yamlFeature("SPLIT_LINES", false) + } + + json { + target("renovate.json") + endWithNewline() + trimTrailingWhitespace() + jackson() + } + + format("toml") { + target("gradle/libs.versions.toml") + endWithNewline() + trimTrailingWhitespace() + prettier(prettierConfig) + .config( + mapOf( + "parser" to "toml", + "plugins" to listOf("prettier-plugin-toml"), + ), + ) + } + + kotlin { + target( + "buildSrc/src/main/kotlin/**/*.kt", + "buildSrc/**/*.gradle.kts", + "*.gradle.kts", + ) + endWithNewline() + trimTrailingWhitespace() + ktfmt().kotlinlangStyle().configure { + it.setMaxWidth(100) + it.setBlockIndent(4) + it.setContinuationIndent(4) + it.setRemoveUnusedImport(true) + } + } + + java { + target( + "src/main/java/**/*.java", + ) + importOrder() + removeUnusedImports() + endWithNewline() + trimTrailingWhitespace() + prettier(prettierConfig) + .config( + mapOf( + "parser" to "java", + "tabWidth" to 4, + "useTabs" to false, + "printWidth" to 100, + "plugins" to listOf("prettier-plugin-java"), + ), + ) + } + } +} diff --git a/example/.gitignore b/example/.gitignore deleted file mode 100644 index a9763ce..0000000 --- a/example/.gitignore +++ /dev/null @@ -1 +0,0 @@ -tilt/example/docker/example.jar diff --git a/example/build.gradle.kts b/example/build.gradle.kts deleted file mode 100644 index c186209..0000000 --- a/example/build.gradle.kts +++ /dev/null @@ -1,73 +0,0 @@ -import java.nio.file.Path - -plugins { - java - id("io.github.goooler.shadow") version "8.1.7" -} - -group = "tr.com.infumia" -version = "1.0.0-SNAPSHOT" - -val tiltFolder: Path = rootProject.layout.projectDirectory.asFile.toPath().resolve("tilt") - -java { - toolchain { - languageVersion = JavaLanguageVersion.of(17) - } -} - -tasks { - jar { - archiveVersion = "" - } - - shadowJar { - archiveClassifier = "" - archiveVersion = "" - - mergeServiceFiles() - - manifest { - attributes( - "Main-Class" to "tr.com.infumia.Main" - ) - } - } - - val outputTask = shadowJar.get() - - register("copyJar") { - val inputJar = outputTask.outputs.files.singleFile - val outputFile = tiltFolder - .resolve("example") - .resolve("docker") - .resolve("example.jar") - .toFile() - - inputs.files(inputJar) - outputs.files(outputFile) - - doLast { - inputJar.copyTo(outputFile, true) - } - - dependsOn(shadowJar) - } - - build { - dependsOn(shadowJar) - finalizedBy("copyJar") - } -} - -repositories { - mavenCentral() - maven("https://jitpack.io/") -} - -dependencies { - implementation("io.grpc:grpc-stub:1.63.0") - implementation("io.grpc:grpc-protobuf:1.63.0") - implementation("io.grpc:grpc-netty:1.63.0") - implementation("com.github.infumia:agones4j:1.0.3") -} diff --git a/example/gradle/wrapper/gradle-wrapper.jar b/example/gradle/wrapper/gradle-wrapper.jar deleted file mode 100644 index e644113..0000000 Binary files a/example/gradle/wrapper/gradle-wrapper.jar and /dev/null differ diff --git a/example/gradle/wrapper/gradle-wrapper.properties b/example/gradle/wrapper/gradle-wrapper.properties deleted file mode 100644 index e7646de..0000000 --- a/example/gradle/wrapper/gradle-wrapper.properties +++ /dev/null @@ -1,7 +0,0 @@ -distributionBase=GRADLE_USER_HOME -distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip -networkTimeout=10000 -validateDistributionUrl=true -zipStoreBase=GRADLE_USER_HOME -zipStorePath=wrapper/dists diff --git a/example/gradlew b/example/gradlew deleted file mode 100644 index 1aa94a4..0000000 --- a/example/gradlew +++ /dev/null @@ -1,249 +0,0 @@ -#!/bin/sh - -# -# Copyright © 2015-2021 the original authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -############################################################################## -# -# Gradle start up script for POSIX generated by Gradle. -# -# Important for running: -# -# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is -# noncompliant, but you have some other compliant shell such as ksh or -# bash, then to run this script, type that shell name before the whole -# command line, like: -# -# ksh Gradle -# -# Busybox and similar reduced shells will NOT work, because this script -# requires all of these POSIX shell features: -# * functions; -# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», -# «${var#prefix}», «${var%suffix}», and «$( cmd )»; -# * compound commands having a testable exit status, especially «case»; -# * various built-in commands including «command», «set», and «ulimit». -# -# Important for patching: -# -# (2) This script targets any POSIX shell, so it avoids extensions provided -# by Bash, Ksh, etc; in particular arrays are avoided. -# -# The "traditional" practice of packing multiple parameters into a -# space-separated string is a well documented source of bugs and security -# problems, so this is (mostly) avoided, by progressively accumulating -# options in "$@", and eventually passing that to Java. -# -# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, -# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; -# see the in-line comments for details. -# -# There are tweaks for specific operating systems such as AIX, CygWin, -# Darwin, MinGW, and NonStop. -# -# (3) This script is generated from the Groovy template -# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt -# within the Gradle project. -# -# You can find Gradle at https://github.com/gradle/gradle/. -# -############################################################################## - -# Attempt to set APP_HOME - -# Resolve links: $0 may be a link -app_path=$0 - -# Need this for daisy-chained symlinks. -while - APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path - [ -h "$app_path" ] -do - ls=$( ls -ld "$app_path" ) - link=${ls#*' -> '} - case $link in #( - /*) app_path=$link ;; #( - *) app_path=$APP_HOME$link ;; - esac -done - -# This is normally unused -# shellcheck disable=SC2034 -APP_BASE_NAME=${0##*/} -# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) -APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit - -# Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD=maximum - -warn () { - echo "$*" -} >&2 - -die () { - echo - echo "$*" - echo - exit 1 -} >&2 - -# OS specific support (must be 'true' or 'false'). -cygwin=false -msys=false -darwin=false -nonstop=false -case "$( uname )" in #( - CYGWIN* ) cygwin=true ;; #( - Darwin* ) darwin=true ;; #( - MSYS* | MINGW* ) msys=true ;; #( - NONSTOP* ) nonstop=true ;; -esac - -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar - - -# Determine the Java command to use to start the JVM. -if [ -n "$JAVA_HOME" ] ; then - if [ -x "$JAVA_HOME/jre/sh/java" ] ; then - # IBM's JDK on AIX uses strange locations for the executables - JAVACMD=$JAVA_HOME/jre/sh/java - else - JAVACMD=$JAVA_HOME/bin/java - fi - if [ ! -x "$JAVACMD" ] ; then - die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -else - JAVACMD=java - if ! command -v java >/dev/null 2>&1 - then - die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -fi - -# Increase the maximum file descriptors if we can. -if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then - case $MAX_FD in #( - max*) - # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. - # shellcheck disable=SC2039,SC3045 - MAX_FD=$( ulimit -H -n ) || - warn "Could not query maximum file descriptor limit" - esac - case $MAX_FD in #( - '' | soft) :;; #( - *) - # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. - # shellcheck disable=SC2039,SC3045 - ulimit -n "$MAX_FD" || - warn "Could not set maximum file descriptor limit to $MAX_FD" - esac -fi - -# Collect all arguments for the java command, stacking in reverse order: -# * args from the command line -# * the main class name -# * -classpath -# * -D...appname settings -# * --module-path (only if needed) -# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. - -# For Cygwin or MSYS, switch paths to Windows format before running java -if "$cygwin" || "$msys" ; then - APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) - CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) - - JAVACMD=$( cygpath --unix "$JAVACMD" ) - - # Now convert the arguments - kludge to limit ourselves to /bin/sh - for arg do - if - case $arg in #( - -*) false ;; # don't mess with options #( - /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath - [ -e "$t" ] ;; #( - *) false ;; - esac - then - arg=$( cygpath --path --ignore --mixed "$arg" ) - fi - # Roll the args list around exactly as many times as the number of - # args, so each arg winds up back in the position where it started, but - # possibly modified. - # - # NB: a `for` loop captures its iteration list before it begins, so - # changing the positional parameters here affects neither the number of - # iterations, nor the values presented in `arg`. - shift # remove old arg - set -- "$@" "$arg" # push replacement arg - done -fi - - -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' - -# Collect all arguments for the java command: -# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, -# and any embedded shellness will be escaped. -# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be -# treated as '${Hostname}' itself on the command line. - -set -- \ - "-Dorg.gradle.appname=$APP_BASE_NAME" \ - -classpath "$CLASSPATH" \ - org.gradle.wrapper.GradleWrapperMain \ - "$@" - -# Stop when "xargs" is not available. -if ! command -v xargs >/dev/null 2>&1 -then - die "xargs is not available" -fi - -# Use "xargs" to parse quoted args. -# -# With -n1 it outputs one arg per line, with the quotes and backslashes removed. -# -# In Bash we could simply go: -# -# readarray ARGS < <( xargs -n1 <<<"$var" ) && -# set -- "${ARGS[@]}" "$@" -# -# but POSIX shell has neither arrays nor command substitution, so instead we -# post-process each arg (as a line of input to sed) to backslash-escape any -# character that might be a shell metacharacter, then use eval to reverse -# that process (while maintaining the separation between arguments), and wrap -# the whole thing up as a single "set" statement. -# -# This will of course break if any of these variables contains a newline or -# an unmatched quote. -# - -eval "set -- $( - printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | - xargs -n1 | - sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | - tr '\n' ' ' - )" '"$@"' - -exec "$JAVACMD" "$@" diff --git a/example/gradlew.bat b/example/gradlew.bat deleted file mode 100644 index 25da30d..0000000 --- a/example/gradlew.bat +++ /dev/null @@ -1,92 +0,0 @@ -@rem -@rem Copyright 2015 the original author or authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem https://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem - -@if "%DEBUG%"=="" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%"=="" set DIRNAME=. -@rem This is normally unused -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Resolve any "." and ".." in APP_HOME to make it shorter. -for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if %ERRORLEVEL% equ 0 goto execute - -echo. 1>&2 -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 -echo. 1>&2 -echo Please set the JAVA_HOME variable in your environment to match the 1>&2 -echo location of your Java installation. 1>&2 - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto execute - -echo. 1>&2 -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 -echo. 1>&2 -echo Please set the JAVA_HOME variable in your environment to match the 1>&2 -echo location of your Java installation. 1>&2 - -goto fail - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* - -:end -@rem End local scope for the variables with windows NT shell -if %ERRORLEVEL% equ 0 goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -set EXIT_CODE=%ERRORLEVEL% -if %EXIT_CODE% equ 0 set EXIT_CODE=1 -if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% -exit /b %EXIT_CODE% - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega diff --git a/example/settings.gradle.kts b/example/settings.gradle.kts deleted file mode 100644 index a6260e8..0000000 --- a/example/settings.gradle.kts +++ /dev/null @@ -1 +0,0 @@ -rootProject.name = "example" diff --git a/example/src/main/java/tr/com/infumia/Main.java b/example/src/main/java/tr/com/infumia/Main.java deleted file mode 100644 index 9077635..0000000 --- a/example/src/main/java/tr/com/infumia/Main.java +++ /dev/null @@ -1,29 +0,0 @@ -package tr.com.infumia; - -import java.time.Duration; -import java.util.concurrent.Executors; -import java.util.concurrent.ScheduledExecutorService; -import java.util.concurrent.TimeUnit; -import tr.com.infumia.agones4j.Agones; - -public final class Main { - public static void main(final String[] args) throws InterruptedException { - final var agones = Agones.builder() - .withChannel() - .withHealthCheck(Duration.ofSeconds(1L), Duration.ofSeconds(1L)) - .withGameServerWatcherExecutor(Executors.newSingleThreadExecutor()) - .build(); - - agones.addGameServerWatcher(server -> System.out.println("Game server update: " + server)); - agones.ready(); - agones.startHealthChecking(); - - sleep(); - } - - private static void sleep() throws InterruptedException { - while (true) { - Thread.sleep(5L); - } - } -} diff --git a/example/tilt/Tiltfile b/example/tilt/Tiltfile deleted file mode 100644 index 36fc110..0000000 --- a/example/tilt/Tiltfile +++ /dev/null @@ -1,2 +0,0 @@ -include('agones/Tiltfile') -include('example/Tiltfile') diff --git a/example/tilt/agones/Tiltfile b/example/tilt/agones/Tiltfile deleted file mode 100644 index ddfc34b..0000000 --- a/example/tilt/agones/Tiltfile +++ /dev/null @@ -1,27 +0,0 @@ -load('ext://helm_remote', 'helm_remote') -load('ext://namespace', 'namespace_create') - -namespace_create('example') - -helm_remote( - 'agones', - namespace='agones-system', - create_namespace=True, - repo_url='https://agones.dev/chart/stable', - values=['./values.yaml'] -) - -k8s_kind('Fleet', image_json_path='{.spec.template.spec.template.spec.containers.*.image}') - -agones_resources = [ - 'agones-controller', - 'agones-extensions', - 'agones-ping', - 'agones-allocator', - 'agones-delete-agones-resources' -] - -for resource in agones_resources: - k8s_resource(resource, labels=['agones']) - -local_resource('agones', cmd='echo ready', resource_deps=agones_resources) diff --git a/example/tilt/agones/values.yaml b/example/tilt/agones/values.yaml deleted file mode 100644 index 6e554c9..0000000 --- a/example/tilt/agones/values.yaml +++ /dev/null @@ -1,58 +0,0 @@ -gameservers: - namespaces: - - example -agones: - image: - tag: 1.40.0 - generateTLS: false - tlsCert: | - -----BEGIN CERTIFICATE----- - MIIDlDCCAnygAwIBAgIRAKv3UYPE/9CMPyCyCwZXVEMwDQYJKoZIhvcNAQELBQAw - IjEgMB4GA1UEAxMXYWRtaXNzaW9uLWNvbnRyb2xsZXItY2EwHhcNMjQwNDI4MjEw - OTIxWhcNMzQwNDI2MjEwOTIxWjAkMSIwIAYDVQQDExlhZ29uZXMtY29udHJvbGxl - ci1zZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1cfb9jlb - f2pHH2VBRHqg3R3yI3x/WPTW27bg/tN0iZssr/aPKqHD9nYEG+QFwVfvuPwiD81r - DpNAXcN2LYNW3eBrSpplbB1bZZewOvvs8M+3MvusntbgwybnABD9a3yiVL5UHbjM - peaDWR/Im388PrrdRLFLkSUcxTYOoa+86+G3mrSWXhgapdjOqmQFZ6NIE6eqq2AG - poUEKQsu5/rrvJo04Brw+YlPvLloUNcLSSVoMtrE2dFKKjOTCETXy6QL9x/zW7zI - owT2mliF63cfS4HJ+PuKJWhfUuohAPK8q/MUWnLQ5W8ahnnuOpKiYrln82p+GUKD - Ro9kXHEo/EgjVQIDAQABo4HCMIG/MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAU - BggrBgEFBQcDAQYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBTM - gXTu8kAsr5GKkDUM5b1i7w69/TBfBgNVHREEWDBWgidhZ29uZXMtY29udHJvbGxl - ci1zZXJ2aWNlLmFnb25lcy1zeXN0ZW2CK2Fnb25lcy1jb250cm9sbGVyLXNlcnZp - Y2UuYWdvbmVzLXN5c3RlbS5zdmMwDQYJKoZIhvcNAQELBQADggEBAGVycraRDMAg - Ra9NTEgKrpXWcyMJlBnR/ikO4rpNMfjEWITUMEyRf7hNfp8+OLGMvv/R9Q8+edRl - gXtkCMuf853lKovgS7coTvRL4EYunaACmPixHXrGxYwnHRG/WV0o6NMZ2w5rZE0h - PRE5uGQmePiszyQjb+rnCIHtyhhP8QZIJtu87RTuqf4hYKJuBNty51HlnWYcpYK3 - g3XwCzMXI+yl+ZDlrG/RWj+4/Tk8KWRUUS8p3f33dqnIFQiupbylXmkfhc8/7tS0 - 4ciEHdSzH1ada1g+6KSLEr6pEqiXCR+/0n98EKjYcgNtUCrt8zYmnK2WXLbpugXQ - GZOtYHtORCQ= - -----END CERTIFICATE----- - tlsKey: | - -----BEGIN RSA PRIVATE KEY----- - MIIEogIBAAKCAQEA1cfb9jlbf2pHH2VBRHqg3R3yI3x/WPTW27bg/tN0iZssr/aP - KqHD9nYEG+QFwVfvuPwiD81rDpNAXcN2LYNW3eBrSpplbB1bZZewOvvs8M+3Mvus - ntbgwybnABD9a3yiVL5UHbjMpeaDWR/Im388PrrdRLFLkSUcxTYOoa+86+G3mrSW - XhgapdjOqmQFZ6NIE6eqq2AGpoUEKQsu5/rrvJo04Brw+YlPvLloUNcLSSVoMtrE - 2dFKKjOTCETXy6QL9x/zW7zIowT2mliF63cfS4HJ+PuKJWhfUuohAPK8q/MUWnLQ - 5W8ahnnuOpKiYrln82p+GUKDRo9kXHEo/EgjVQIDAQABAoIBAFIGn3V4SI05ABUh - yss1qidtaA0JpetB9nbTUr0z8VEjQyA5IHGhJAma+rSg5zxqO0blJ0Sc8ujiwx22 - 888+x8PWahRz7VpwYTM34pyfMSis6oQbYP6JQDBg6t1xp2ropXiSlr/Yul0ld1xo - /5X6WelP1bqXtID6lnFs7mxHe9udSkcyoidvOL2Dfqrs/yxFhFd5ESZuSi3t43yE - Uk5XFTra//XfR/A3eIxJHurEKbHqA+Cw0tGOMKFBproUZDcNQtGYeiNT4BvK6YaB - ojoytrYOTY0OOREY3IPm82OyKXo4FEwSv7lKoyTZZ4w/S09SM326WpSfTDXCur0C - pYbXHYECgYEA7DIRgx0cib72PdCbhLsjc1LUrbHL0kpwKqIr2pS9sDFqzXx2ehh1 - ISs98sbjeIz3LKfbgWA+0ALPQ/jR+svLt0+lC7duVKUscsQljsKIYOvaszeSay1z - 8Bw9BI6sk1hWVOmcuTr2HYCVuIoP19T6fmPSgRdUioaNp7D0uXJVI6UCgYEA57Sn - 8rdT5AIlaNEIBzo0nGdstUStJAHr/a8bnDajWQwrm7/DhFfPdJeyHc3YPnB7I3gN - 3hKi978pGVSFwWAEDBlTfQ2yARO0A7XVYOBbKD5U5SmUjMhpk2Mw5TM9nkGoiBkH - U9+M4HD2/7x0THOBWj1q/LZpWfalec6DbzfjMfECgYBfjnoLQ3HSQJG6vHTOpC9Z - br9gbjf5oefzN5zqV5bOe4+sBpigGNj6TFZJrDFHCjDNvjNOCjQfT6Ou6jF5d425 - Yd1x+goG8LQk0jonoYgvPfxC2U7BUahAEgyVlWs4SVrUC5c+UR5VHTp1aFW0ihO1 - ooj9dQTc7kbM+whnJlxPiQKBgFu0ImxrpmYte0TaxkSmAsCMJngvsB76K76BmXng - HhJWQMQpx2YPounQSAyHtbgwqGvHTiXAVoObQtblnvKD39YyB9sMmpDWjX6Sbtsi - sLFiyhLQvBxkDXTp4yYze4WxEtSao03MwmLqErfwjE7dwCpI+JkAUP3sIl3tIBPa - mK7hAoGAVGVYp+4oyjuj2UBYGV17ztVCbyvlUIe1sU8lrBlVV5kPSymeNFXqmQHw - LAzcqP+kdHu0mqYwh0TlcZPz34dVkVTtc1m6FkyWDVD5r6QuC5qARHt1EaVny7xT - ZEi5AuqxCOurvTLAgUizTLYz/rUes3/rDkKMSVYf0KbJX7pN6uU= - -----END RSA PRIVATE KEY----- diff --git a/example/tilt/example/Tiltfile b/example/tilt/example/Tiltfile deleted file mode 100644 index 0121bcf..0000000 --- a/example/tilt/example/Tiltfile +++ /dev/null @@ -1,13 +0,0 @@ -docker_build( - ref='local/infumia/agones4j-example', - context='./docker/', - dockerfile='./docker/Dockerfile' -) - -k8s_yaml(helm( - './charts/', - name='agones4j-example', - namespace='example' -)) - -k8s_resource('example-fleet', resource_deps=['agones']) diff --git a/example/tilt/example/charts/Chart.yaml b/example/tilt/example/charts/Chart.yaml deleted file mode 100644 index f03b727..0000000 --- a/example/tilt/example/charts/Chart.yaml +++ /dev/null @@ -1,4 +0,0 @@ -apiVersion: v2 -version: 1.0.0 -name: agones4j-example -type: application diff --git a/example/tilt/example/charts/templates/server.yaml b/example/tilt/example/charts/templates/server.yaml deleted file mode 100644 index d9ed5a5..0000000 --- a/example/tilt/example/charts/templates/server.yaml +++ /dev/null @@ -1,23 +0,0 @@ ---- -apiVersion: agones.dev/v1 -kind: Fleet -metadata: - name: example-fleet - namespace: {{ .Release.Namespace }} -spec: - replicas: 1 - scheduling: Distributed - template: - spec: - health: - initialDelaySeconds: 5 - periodSeconds: 3 - template: - metadata: - labels: - app: example-game-server - spec: - containers: - - name: minecraft - imagePullPolicy: Never - image: local/infumia/agones4j-example:latest diff --git a/example/tilt/example/docker/Dockerfile b/example/tilt/example/docker/Dockerfile deleted file mode 100644 index a0941ce..0000000 --- a/example/tilt/example/docker/Dockerfile +++ /dev/null @@ -1,7 +0,0 @@ -FROM eclipse-temurin:17-jre - -WORKDIR /app - -COPY example.jar example.jar - -CMD ["java", "-jar", "example.jar"] diff --git a/gradle.properties b/gradle.properties index 368c19e..4418a7d 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ name=agones4j -group=tr.com.infumia +group=net.infumia version=1.0.0-SNAPSHOT org.gradle.parallel=true diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index c193644..847ddef 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -9,5 +9,6 @@ grpc-stub = { module = "io.grpc:grpc-stub", version.ref = "grpc" } grpc-protobuf = { module = "io.grpc:grpc-protobuf", version.ref = "grpc" } annotationsapi = { module = "org.apache.tomcat:annotations-api", version = "6.0.53" } -[plugins] -protobuf = { id = "com.google.protobuf", version = "0.9.4" } +nexus-plugin = { module = "com.vanniktech:gradle-maven-publish-plugin", version = "0.29.0" } +spotless-plugin = { module = "com.diffplug.spotless:spotless-plugin-gradle", version = "6.25.0" } +protobuf-plugin = { module = "com.google.protobuf:protobuf-gradle-plugin", version = "0.9.4" } diff --git a/renovate.json b/renovate.json index 8f82b0a..2e0f7b2 100644 --- a/renovate.json +++ b/renovate.json @@ -1,18 +1,10 @@ { - "extends": [ - "config:base" - ], - "labels": ["dependencies"], - "schedule": [ - "after 9am" - ], - "packageRules": [ - { - "matchUpdateTypes": ["major", "minor", "patch", "pin", "digest", "lockFileMaintenance", "rollback", "bump"], - "automerge": true - } - ], - "ignorePaths": [ - "example" - ] -} + "extends": [ "config:base" ], + "labels": [ "dependencies" ], + "schedule": [ "after 9am" ], + "packageRules": [ { + "matchUpdateTypes": [ "major", "minor", "patch", "pin", "digest", "lockFileMaintenance", "rollback", "bump" ], + "automerge": true + } ], + "ignorePaths": [ "example" ] +} \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts index b68873d..7c44e84 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1 +1,3 @@ +plugins { id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" } + rootProject.name = "agones4j" diff --git a/src/main/java/net/infumia/agones4j/Agones.java b/src/main/java/net/infumia/agones4j/Agones.java new file mode 100644 index 0000000..ea58357 --- /dev/null +++ b/src/main/java/net/infumia/agones4j/Agones.java @@ -0,0 +1,870 @@ +package net.infumia.agones4j; + +import agones.dev.sdk.Sdk; +import agones.dev.sdk.alpha.Alpha; +import io.grpc.ManagedChannel; +import io.grpc.ManagedChannelBuilder; +import io.grpc.stub.StreamObserver; +import java.time.Duration; +import java.util.List; +import java.util.Objects; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.function.Consumer; + +/** + * The interface provides methods to interact with Agones. + */ +public interface Agones extends AutoCloseable { + /** + * Retrieves a new instance of the Agones builder. + * + * @return A new instance of the Agones builder. + */ + static Agones.Builder builder() { + return new AgonesImpl.Builder(); + } + + /** + * Checks if it can watch game server. + *

+ * To enable game server watcher, use {@link Builder#withGameServerWatcherExecutor(ExecutorService)}. + * + * @return {@code true} if it can watch game server, {@code false} otherwise. + */ + boolean canWatchGameServer(); + + /** + * Adds a game server watcher. + *

+ * Game server watchers are called whenever a game server event occurs. + * + * @param watcher A consumer that represents the game server watcher. + * + * @see #canWatchGameServer() + */ + void addGameServerWatcher(Consumer watcher); + + /** + * Checks if it can use health check system of Agones. + *

+ * To enable health check, use {@link Builder#withHealthCheck(Duration, Duration)}. + * + * @return {@code true} if it can use health check system of Agones, {@code false} otherwise. + */ + boolean canHealthCheck(); + + /** + * Starts the health checking. + * + * @throws IllegalStateException if the health check interval not specified. + * @see #canHealthCheck() + */ + void startHealthChecking(); + + /** + * Stops the health checking. + */ + void stopHealthChecking(); + + /** + * Creates a new health check stream. + * + * @param response the response from server. + * + * @return a stream observer to send health check requests. + * + * @see #canHealthCheck() + */ + StreamObserver healthCheckStream(StreamObserver response); + + /** + * Creates a new health check stream. + * + * @return a stream observer to send health check requests. + * + * @see #canHealthCheck() + */ + default StreamObserver healthCheckStream() { + return this.healthCheckStream(Internal.observerEmpty()); + } + + /** + * Call to self Allocation the GameServer. + * + * @param response the response from server. + */ + void allocate(StreamObserver response); + + /** + * Call to self Allocation the GameServer. + */ + default void allocate() { + this.allocate(Internal.observerEmpty()); + } + + /** + * Call to self Allocation the GameServer. + * + * @return A future that represents the result of the allocation operation. + */ + default CompletableFuture allocateFuture() { + return Internal.observerToFuture(this::allocate); + } + + /** + * Retrieves the current GameServer data. + * + * @param response the response from server. + */ + void getGameServer(StreamObserver response); + + /** + * Retrieves the current GameServer data. + * + * @return A future that represents the current game server. + */ + default CompletableFuture getGameServerFuture() { + return Internal.observerToFuture(this::getGameServer); + } + + /** + * Call when the GameServer is ready. + * + * @param response the response from server. + */ + void ready(StreamObserver response); + + /** + * Call when the GameServer is ready. + */ + default void ready() { + this.ready(Internal.observerEmpty()); + } + + /** + * Call when the @link Sdk.GameServer is ready. + * + * @return A future that represents the result of the ready operation. + */ + default CompletableFuture readyFuture() { + return Internal.observerToFuture(this::ready); + } + + /** + * Marks the @link Sdk.GameServer as the Reserved state for Duration. + * + * @param duration the duration to mark. + * @param response the response from server. + */ + void reserve(Duration duration, StreamObserver response); + + /** + * Marks the @link Sdk.GameServer as the Reserved state for Duration. + * + * @param duration the duration to mark. + */ + default void reserve(final Duration duration) { + this.reserve(duration, Internal.observerEmpty()); + } + + /** + * Marks the @link Sdk.GameServer as the Reserved state for Duration. + * + * @param duration the duration to mark. + * + * @return A future that represents the result of the reserve operation. + */ + default CompletableFuture reserveFuture(final Duration duration) { + return Internal.observerToFuture(response -> this.reserve(duration, response)); + } + + /** + * Call when the @link Sdk.GameServer is shutting down. + * + * @param response the response from server. + */ + void shutdown(StreamObserver response); + + /** + * Call when the @link Sdk.GameServer is shutting down. + */ + default void shutdown() { + this.shutdown(Internal.observerEmpty()); + } + + /** + * Call when the @link Sdk.GameServer is shutting down. + * + * @return A future that represents the result of the shutdown operation. + */ + default CompletableFuture shutdownFuture() { + return Internal.observerToFuture(this::shutdown); + } + + /** + * Apply an Annotation to the backing @link Sdk.GameServer metadata. + * + * @param key the key to apply. + * @param value the value to apply. + * @param observer the observer to apply. + */ + void setAnnotation(String key, String value, StreamObserver observer); + + /** + * Apply an Annotation to the backing @link Sdk.GameServer metadata. + * + * @param key the key to apply. + * @param value the value to apply. + */ + default void setAnnotation(final String key, final String value) { + this.setAnnotation(key, value, Internal.observerEmpty()); + } + + /** + * Apply an Annotation to the backing @link Sdk.GameServer metadata. + * + * @param key the key to apply. + * @param value the value to apply. + * + * @return A future that represents the result of the set annotation operation. + */ + default CompletableFuture setAnnotationFuture(final String key, final String value) { + return Internal.observerToFuture(response -> this.setAnnotation(key, value, response)); + } + + /** + * Apply a Label to the backing @link Sdk.GameServer metadata. + * + * @param key the key to apply. + * @param value the value to apply. + * @param response the response from server. + */ + void setLabel(String key, String value, StreamObserver response); + + /** + * Apply a Label to the backing @link Sdk.GameServer metadata. + * + * @param key the key to apply. + * @param value the value to apply. + */ + default void setLabel(final String key, final String value) { + this.setLabel(key, value, Internal.observerEmpty()); + } + + /** + * Apply a Label to the backing @link Sdk.GameServer metadata. + * + * @param key the key to apply. + * @param value the value to apply. + * + * @return A future that represents the result of the set label operation. + */ + default CompletableFuture setLabelFuture(final String key, final String value) { + return Internal.observerToFuture(response -> this.setLabel(key, value, response)); + } + + /** + * Returns the list of the currently connected player ids. + *

+ * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the + * @link Sdk.GameServer status resource. + *

+ * If GameServer#Status#PlayerStatus#getIdsList is set manually through the Kubernetes API, use + * {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. + * + * @param response the response from server. + */ + void getConnectedPlayersFuture(StreamObserver> response); + + /** + * Returns the list of the currently connected player ids. + *

+ * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the + * @link Sdk.GameServer status resource. + *

+ * If GameServer#Status#PlayerStatus#getIdsList is set manually through the Kubernetes API, use + * {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. + * + * @return A future that represents the list of the currently connected player ids. + */ + default CompletableFuture> getConnectedPlayersFuture() { + return Internal.observerToFuture(this::getConnectedPlayersFuture); + } + + /** + * Increases the SDK’s stored player count by one, and appends this playerID to GameServer#Status#PlayerStatus#getIdsList. + *

+ * GameServer#Status#PlayerStatus#getCount and GameServer#Status#PlayerStatus#getIdsList are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. + *

+ * The response returns true and adds the playerID to the list of playerIDs if this playerID was not already in the list of connected playerIDs. + *

+ * If the playerID exists within the list of connected playerIDs, will return false, and the list of connected playerIDs will be left unchanged. + *

+ * An error will be returned if the playerID was not already in the list of connected playerIDs but the player capacity for the server has been reached. + * The playerID will not be added to the list of playerIDs. + *

+ * WARNING: Do not use this method if you are manually managing GameServer#Status#PlayerStatus#getIdsList and GameServer#Status#PlayerStatus#getCount through the Kubernetes API, as indeterminate results will occur. + * + * @param playerId the player id to connect. + * @param response the response from server. + */ + void playerConnect(String playerId, StreamObserver response); + + /** + * Increases the SDK’s stored player count by one, and appends this playerID to GameServer#Status#PlayerStatus#getIdsList. + * GameServer#Status#PlayerStatus#getCount and GameServer#Status#PlayerStatus#getIdsList are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. + *

+ * If the playerID exists within the list of connected playerIDs, will return false, and the list of connected playerIDs will be left unchanged. + *

+ * An error will be returned if the playerID was not already in the list of connected playerIDs but the player capacity for the server has been reached. + * The playerID will not be added to the list of playerIDs. + *

+ * WARNING: Do not use this method if you are manually managing GameServer#Status#PlayerStatus#getIdsList and GameServer#Status#PlayerStatus#getCount through the Kubernetes API, as indeterminate results will occur. + * + * @param playerId the player id to connect. + * + * @return A future that represents the result of the player connect operation. + */ + default CompletableFuture playerConnectFuture(final String playerId) { + return Internal.observerToFuture(response -> this.playerConnect(playerId, response)); + } + + /** + * Decreases the SDK’s stored player count by one, and removes the playerID from GameServer#Status#PlayerStatus#getIdsList + * GameServer#Status#PlayerStatus#getCount and GameServer#Status#PlayerStatus#getIdsList are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. + *

+ * The response returns true and removes the playerID from the list of connected playerIDs if the playerID value exists within the list. + *

+ * If the playerID was not in the list of connected playerIDs, the call will return false, and the connected playerID list will be left unchanged. + *

+ * WARNING: Do not use this method if you are manually managing GameServer#Status#PlayerStatus#getIdsList and GameServer#Status#PlayerStatus#getCount through the Kubernetes API, as indeterminate results will occur. + * + * @param playerId the player id to disconnect. + * @param response the response from server. + */ + void playerDisconnect(String playerId, StreamObserver response); + + /** + * Decreases the SDK’s stored player count by one, and removes the playerID from GameServer#Status#PlayerStatus#getIdsList + * GameServer#Status#PlayerStatus#getCount and GameServer#Status#PlayerStatus#getIdsList are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. + *

+ * If the playerID was not in the list of connected playerIDs, the call will return false, and the connected playerID list will be left unchanged. + *

+ * WARNING: Do not use this method if you are manually managing GameServer#Status#PlayerStatus#getIdsList and GameServer#Status#PlayerStatus#getCount through the Kubernetes API, as indeterminate results will occur. + * + * @param playerId the player id to disconnect. + * + * @return A future that represents the result of the player disconnect operation. + */ + default CompletableFuture playerDisconnectFuture(final String playerId) { + return Internal.observerToFuture(response -> this.playerDisconnect(playerId, response)); + } + + /** + * Returns if the playerID is currently connected to the @link Sdk.GameServer. + *

+ * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. + *

+ * If GameServer#Status#PlayerStatus#getIdsList is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to determine connected status. + * + * @param playerId the player id to return. + * @param response the response from server. + */ + void isPlayerConnected(String playerId, StreamObserver response); + + /** + * Returns if the playerID is currently connected to the @link Sdk.GameServer. + *

+ * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. + *

+ * If GameServer#Status#PlayerStatus#getIdsList is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to determine connected status. + * + * @param playerId the player id to return. + * + * @return A future that represents the result of the is player connected operation. + */ + default CompletableFuture isPlayerConnected(final String playerId) { + return Internal.observerToFuture(response -> this.isPlayerConnected(playerId, response)); + } + + /** + * Update the GameServer#Status#PlayerStatus#getCapacity value with a new capacity. + * + * @param capacity the capacity to update. + * @param response the response from server. + */ + void setPlayerCapacity(long capacity, StreamObserver response); + + /** + * Update the GameServer#Status#PlayerStatus#getCapacity value with a new capacity. + * + * @param capacity the capacity to update. + * + * @return A future that represents the result of the set player capacity operation. + */ + default CompletableFuture setPlayerCapacityFuture(final long capacity) { + return Internal.observerToFuture(response -> this.setPlayerCapacity(capacity, response)); + } + + /** + * Retrieves the current player capacity. + *

+ * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. + *

+ * If GameServer#Status#PlayerStatus#getCapacity is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. + * + * @param response the response from server. + */ + void getPlayerCapacity(StreamObserver response); + + /** + * Retrieves the current player capacity. + *

+ * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. + *

+ * If GameServer#Status#PlayerStatus#getCapacity is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. + * + * @return A future that represents the current player capacity. + */ + default CompletableFuture getPlayerCapacityFuture() { + return Internal.observerToFuture(this::getPlayerCapacity); + } + + /** + * Retrieves the current player count. + *

+ * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. + *

+ * If GameServer#Status#PlayerStatus#getCount is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. + * + * @param response the response from server. + */ + void getPlayerCount(StreamObserver response); + + /** + * Retrieves the current player count. + *

+ * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. + *

+ * If GameServer#Status#PlayerStatus#getCount is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. + * + * @return A future that represents the current player count. + */ + default CompletableFuture getPlayerCountFuture() { + return Internal.observerToFuture(this::getPlayerCount); + } + + /** + * gets a list. + *

+ * returns NOT_FOUND if the List does not exist. + * + * @param name the name to get. + * @param response the response from server. + */ + void getList(String name, StreamObserver response); + + /** + * gets a list. + *

+ * Returns NOT_FOUND if the List does not exist. + * + * @param name the name to get. + * + * @return the list. + */ + default CompletableFuture getList(final String name) { + return Internal.observerToFuture(response -> this.getList(name, response)); + } + + /** + * Adds a value to a list and returns updated list. + *

+ * Returns NOT_FOUND if the list does not exist. + *

+ * Returns ALREADY_EXISTS if the value is already in the list. + *

+ * Returns OUT_OF_RANGE if the list is already at Capacity. + * + * @param name the name to add. + * @param value the value to add. + * @param response the response from server. + */ + void addList(String name, String value, StreamObserver response); + + /** + * Adds a value to a list and returns updated list. + *

+ * Returns NOT_FOUND if the list does not exist. + *

+ * Returns ALREADY_EXISTS if the value is already in the list. + *

+ * Returns OUT_OF_RANGE if the list is already at Capacity. + * + * @param name the name to add. + * @param value the value to add. + * + * @return the updated list. + */ + default CompletableFuture addListFuture(final String name, final String value) { + return Internal.observerToFuture(response -> this.addList(name, value, response)); + } + + /** + * Removes a value from a list and returns updated list. + *

+ * Returns NOT_FOUND if the list does not exist. + *

+ * Returns NOT_FOUND if the value is not in the list. + * + * @param name the name to remove. + * @param value the value to remove. + * @param response the response from server. + */ + void removeList(String name, String value, StreamObserver response); + + /** + * Removes a value from a list and returns updated list. + *

+ * Returns NOT_FOUND if the list does not exist. + *

+ * Returns NOT_FOUND if the value is not in the list. + * + * @param name the name to remove. + * @param value the value to remove. + * + * @return the updated list. + */ + default CompletableFuture removeListFuture(final String name, final String value) { + return Internal.observerToFuture(response -> this.removeList(name, value, response)); + } + + /** + * Returns the updated list. + *

+ * Returns NOT_FOUND if the list does not exist (name cannot be updated). + *

+ * THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES. + *

+ * Use {@link #addListFuture(String, String)} or {@link #removeListFuture(String, String)} for modifying the + * List.Values field. + *

+ * Returns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the list. + * + * @param list the list to update. + * @param updateMask the update mask to update. + * @param response the response from server. + */ + void updateList(AgonesList list, List updateMask, StreamObserver response); + + /** + * Returns the updated list. + *

+ * Returns NOT_FOUND if the list does not exist (name cannot be updated). + *

+ * THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES. + *

+ * Use {@link #addListFuture(String, String)} or {@link #removeListFuture(String, String)} for modifying the + * List.Values field. + *

+ * Returns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the list. + * + * @param list the list to update. + * @param updateMask the update mask to update. + * + * @return the updated list. + */ + default CompletableFuture updateList( + final AgonesList list, + final List updateMask + ) { + return Internal.observerToFuture(response -> this.updateList(list, updateMask, response)); + } + + /** + * gets a counter. + *

+ * Returns NOT_FOUND if the counter does not exist. + * + * @param name the name of the counter. + * @param response the response from server. + */ + void getCounter(String name, StreamObserver response); + + /** + * gets a counter. + *

+ * Returns NOT_FOUND if the counter does not exist. + * + * @param name the name of the counter. + * + * @return the counter. + */ + default CompletableFuture getCounterFuture(final String name) { + return Internal.observerToFuture(response -> this.getCounter(name, response)); + } + + /** + * Increases the count of the Counter by the specified amount. + *

+ * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + *

+ * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. + * + * @param name the name of the counter. + * @param amount the amount to increase. + * @param response the response from server. + */ + void increaseCounter(String name, long amount, StreamObserver response); + + /** + * Increases the count of the Counter by the specified amount. + *

+ * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + *

+ * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. + * + * @param name the name of the counter. + * @param amount the amount to increase. + * + * @return the counter. + */ + default CompletableFuture increaseCounterFuture( + final String name, + final long amount + ) { + return Internal.observerToFuture(response -> this.increaseCounter(name, amount, response)); + } + + /** + * Decreases the count of the Counter by the specified amount. + *

+ * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + *

+ * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. + * + * @param name the name of the counter. + * @param amount the amount to decrease. + * @param response the response from server. + */ + void decreaseCounter(String name, long amount, StreamObserver response); + + /** + * Decreases the count of the Counter by the specified amount. + *

+ * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + *

+ * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. + * + * @param name the name of the counter. + * @param amount the amount to decrease. + * + * @return the counter. + */ + default CompletableFuture decreaseCounter(final String name, final long amount) { + return Internal.observerToFuture(response -> this.decreaseCounter(name, amount, response)); + } + + /** + * Sets the count of the Counter by the specified amount. + *

+ * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + *

+ * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. + * + * @param name the name of the counter. + * @param amount the amount to set. + * @param response the response from server. + */ + void setCounterCount(String name, long amount, StreamObserver response); + + /** + * Sets the count of the Counter by the specified amount. + *

+ * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + *

+ * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. + * + * @param name the name of the counter. + * @param amount the amount to set. + * + * @return the counter. + */ + default CompletableFuture setCounterCountFuture(String name, long amount) { + return Internal.observerToFuture(response -> this.setCounterCount(name, amount, response)); + } + + /** + * Sets the capacity of the Counter by the specified amount. + *

+ * 0 is no limit. + *

+ * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + * + * @param name the name of the counter. + * @param amount the amount to set. + * @param response the response from server. + */ + void setCounterCapacity(String name, long amount, StreamObserver response); + + /** + * Sets the capacity of the Counter by the specified amount. + *

+ * 0 is no limit. + *

+ * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + * + * @param name the name of the counter. + * @param amount the amount to set. + * + * @return the counter. + */ + default CompletableFuture setCounterCapacityFuture( + final String name, + final long amount + ) { + return Internal.observerToFuture( + response -> this.setCounterCapacity(name, amount, response) + ); + } + + /** + * A builder for creating instances of Agones with specified configurations. + */ + interface Builder { + /** + * Builds an instance of Agones using the specified configuration. + * + * @return An instance of Agones. + */ + Agones build(); + + /** + * Sets the address for the Agones Builder. + * + * @param host The host address to be set. + * @param port The port number to be set. + * + * @return The Agones Builder instance. + * + * @see ManagedChannelBuilder#forAddress(String, int) + * @see ManagedChannelBuilder#usePlaintext() + */ + default Builder withAddress(final String host, final int port) { + return this.withChannel( + ManagedChannelBuilder.forAddress(host, port).usePlaintext().build() + ); + } + + /** + * Sets the address for the Agones Builder. + * + * @param host The host address to be set. + * + * @return The Agones Builder instance. + */ + default Builder withAddress(final String host) { + return this.withAddress(host, Internal.GRPC_PORT); + } + + /** + * Sets the address for the Agones Builder. + * + * @param port The port number to be set. + * + * @return The Agones Builder instance. + */ + default Builder withAddress(final int port) { + return this.withAddress(Internal.GRPC_HOST, port); + } + + /** + * Sets the address for the Agones Builder. + * + * @return The Agones Builder instance. + */ + default Builder withAddress() { + return this.withAddress(Internal.GRPC_HOST); + } + + /** + * Sets the target for the Agones Builder. + * + * @param target The target to be set. + * + * @return The Agones Builder instance. + * + * @see ManagedChannelBuilder#forTarget(String) + * @see ManagedChannelBuilder#usePlaintext() + */ + default Builder withTarget(final String target) { + return this.withChannel(ManagedChannelBuilder.forTarget(target).usePlaintext().build()); + } + + /** + * Sets the target for the Agones Builder. + * + * @return The Agones Builder instance. + */ + default Builder withTarget() { + Objects.requireNonNull( + Internal.GRPC_ADDRESS, + "Environment variable 'AGONES_SDK_GRPC_ADDRESS' is not set!" + ); + return this.withTarget(Internal.GRPC_ADDRESS); + } + + /** + * Sets the channel from environment variables for the Agones Builder. + * + * @return The Agones Builder instance. + */ + default Builder withChannel() { + if (Internal.GRPC_ADDRESS == null) { + return this.withAddress(); + } else { + return this.withTarget(); + } + } + + /** + * Sets the ManagedChannel for the Agones Builder. + * + * @param channel The ManagedChannel to be set. + * + * @return The Agones Builder instance. + */ + Builder withChannel(ManagedChannel channel); + + /** + * Sets the executor for the game server watcher. + * + * @param executor The executor service to be used by the game server watcher. {@code null} to disable it. Disabled by default. + * + * @return The Agones Builder instance. + */ + Builder withGameServerWatcherExecutor(ExecutorService executor); + + /** + * Sets the health check interval for the Agones Builder. + * + * @param delay The delay duration for health checks. {@code null} to disable it. Disabled by default. + * @param period The interval duration for health checks. + * + * @return The Agones Builder instance. + */ + Builder withHealthCheck(Duration delay, Duration period); + + /** + * Sets the health check executor for the builder. + * + * @param executor the scheduled executor service to be used for health checks. {@code null} to disable it. Default is {@link Executors#newSingleThreadScheduledExecutor()} + * + * @return The Agones Builder instance. + */ + Builder withHealthCheckExecutor(ScheduledExecutorService executor); + } +} diff --git a/src/main/java/net/infumia/agones4j/AgonesCounter.java b/src/main/java/net/infumia/agones4j/AgonesCounter.java new file mode 100644 index 0000000..e5b7d57 --- /dev/null +++ b/src/main/java/net/infumia/agones4j/AgonesCounter.java @@ -0,0 +1,77 @@ +package net.infumia.agones4j; + +import java.util.Objects; +import java.util.StringJoiner; + +/** + * Represents a counter in the Agones system. + */ +public final class AgonesCounter { + + private final String name; + private final long capacity; + private final long count; + + AgonesCounter(final String name, final long capacity, final long count) { + this.name = name; + this.capacity = capacity; + this.count = count; + } + + /** + * Retrieves the counter name. + * + * @return the name. + */ + public String getName() { + return this.name; + } + + /** + * Retrieves the counter capacity. + * + * @return the capacity. + */ + public long getCapacity() { + return this.capacity; + } + + /** + * Returns the counter count. + * + * @return the count. + */ + public long getCount() { + return this.count; + } + + @Override + public boolean equals(final Object obj) { + if (this == obj) { + return true; + } + if (obj == null || this.getClass() != obj.getClass()) { + return false; + } + final AgonesCounter that = (AgonesCounter) obj; + return ( + Objects.equals(this.capacity, that.capacity) && + Objects.equals(this.name, that.name) && + Objects.equals(this.count, that.count) + ); + } + + @Override + public int hashCode() { + return Objects.hash(this.name, this.capacity, this.count); + } + + @Override + public String toString() { + return new StringJoiner(", ", AgonesCounter.class.getSimpleName() + "[", "]") + .add("name='" + this.name + "'") + .add("capacity=" + this.capacity) + .add("count=" + this.count) + .toString(); + } +} diff --git a/src/main/java/net/infumia/agones4j/AgonesImpl.java b/src/main/java/net/infumia/agones4j/AgonesImpl.java new file mode 100644 index 0000000..06401aa --- /dev/null +++ b/src/main/java/net/infumia/agones4j/AgonesImpl.java @@ -0,0 +1,431 @@ +package net.infumia.agones4j; + +import agones.dev.sdk.Sdk; +import agones.dev.sdk.alpha.Alpha; +import agones.dev.sdk.beta.Beta; +import com.google.protobuf.FieldMask; +import com.google.protobuf.Int64Value; +import io.grpc.ManagedChannel; +import io.grpc.stub.StreamObserver; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Objects; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.ScheduledFuture; +import java.util.concurrent.TimeUnit; +import java.util.function.Consumer; + +final class AgonesImpl implements Agones { + + private final ManagedChannel channel; + + private final agones.dev.sdk.SDKGrpc.SDKStub sdk; + private final agones.dev.sdk.beta.SDKGrpc.SDKStub beta; + private final agones.dev.sdk.alpha.SDKGrpc.SDKStub alpha; + + private final ExecutorService gameServerWatcherExecutor; + private List> gameServerWatchers; + + private final Duration healthCheckDelay; + private final ScheduledExecutorService healthCheckExecutor; + private final Duration healthCheckPeriod; + private ScheduledFuture healthCheckTask; + + private AgonesImpl(final Builder builder) { + this.channel = builder.channel; + this.gameServerWatcherExecutor = builder.gameServerWatcherExecutor; + this.healthCheckExecutor = builder.healthCheckExecutor(); + this.healthCheckDelay = builder.healthCheckDelay; + this.healthCheckPeriod = builder.healthCheckPeriod; + this.sdk = agones.dev.sdk.SDKGrpc.newStub(builder.channel); + this.beta = agones.dev.sdk.beta.SDKGrpc.newStub(builder.channel); + this.alpha = agones.dev.sdk.alpha.SDKGrpc.newStub(builder.channel); + } + + @Override + public boolean canWatchGameServer() { + return this.gameServerWatcherExecutor != null; + } + + @Override + public void addGameServerWatcher(final Consumer watcher) { + Objects.requireNonNull( + this.gameServerWatcherExecutor, + "Game server watcher is not enabled!" + ); + if (this.gameServerWatchers == null) { + this.gameServerWatchers = Collections.synchronizedList(new ArrayList<>()); + final StreamObserver response = Internal.observerOnNext( + this.gameServerWatcherExecutor, + this.gameServerWatchers + ); + this.sdk.watchGameServer(Sdk.Empty.getDefaultInstance(), response); + } + this.gameServerWatchers.add(watcher); + } + + @Override + public boolean canHealthCheck() { + return ( + this.healthCheckExecutor != null && + this.healthCheckDelay != null && + this.healthCheckPeriod != null + ); + } + + @Override + public void startHealthChecking() { + if ( + this.healthCheckExecutor == null || + this.healthCheckDelay == null || + this.healthCheckPeriod == null + ) { + throw new IllegalStateException("Health check is not enabled!"); + } + if (this.healthCheckTask != null) { + this.healthCheckTask.cancel(true); + } + final StreamObserver request = this.healthCheckStream(Internal.observerEmpty()); + this.healthCheckTask = this.healthCheckExecutor.scheduleAtFixedRate( + () -> { + if (this.healthCheckTask != null && !this.healthCheckTask.isDone()) { + request.onNext(Sdk.Empty.getDefaultInstance()); + } + }, + this.healthCheckDelay.toMillis(), + this.healthCheckPeriod.toMillis(), + TimeUnit.MILLISECONDS + ); + } + + @Override + public void stopHealthChecking() { + if (this.healthCheckTask != null) { + this.healthCheckTask.cancel(true); + this.healthCheckTask = null; + } + } + + @Override + public StreamObserver healthCheckStream(final StreamObserver response) { + return this.sdk.health(response); + } + + @Override + public void allocate(final StreamObserver response) { + this.sdk.allocate(Sdk.Empty.getDefaultInstance(), response); + } + + @Override + public void getGameServer(final StreamObserver response) { + this.sdk.getGameServer(Sdk.Empty.getDefaultInstance(), response); + } + + @Override + public void ready(final StreamObserver response) { + this.sdk.ready(Sdk.Empty.getDefaultInstance(), response); + } + + @Override + public void reserve(final Duration duration, final StreamObserver response) { + this.sdk.reserve( + Sdk.Duration.newBuilder().setSeconds(duration.getSeconds()).build(), + response + ); + } + + @Override + public void shutdown(final StreamObserver response) { + this.sdk.shutdown(Sdk.Empty.getDefaultInstance(), response); + } + + @Override + public void setAnnotation( + final String key, + final String value, + final StreamObserver observer + ) { + this.sdk.setAnnotation( + Sdk.KeyValue.newBuilder().setKey(key).setValue(value).build(), + observer + ); + } + + @Override + public void setLabel( + final String key, + final String value, + final StreamObserver response + ) { + this.sdk.setLabel(Sdk.KeyValue.newBuilder().setKey(key).setValue(value).build(), response); + } + + @Override + public void getConnectedPlayersFuture(final StreamObserver> response) { + this.alpha.getConnectedPlayers( + Alpha.Empty.getDefaultInstance(), + Internal.observerMap(response, Alpha.PlayerIDList::getListList) + ); + } + + @Override + public void playerConnect(final String playerId, final StreamObserver response) { + this.alpha.playerConnect( + Alpha.PlayerID.newBuilder().setPlayerID(playerId).build(), + Internal.observerMap(response, Alpha.Bool::getBool) + ); + } + + @Override + public void playerDisconnect(final String playerId, final StreamObserver response) { + this.alpha.playerDisconnect( + Alpha.PlayerID.newBuilder().setPlayerID(playerId).build(), + Internal.observerMap(response, Alpha.Bool::getBool) + ); + } + + @Override + public void isPlayerConnected(final String playerId, final StreamObserver response) { + this.alpha.isPlayerConnected( + Alpha.PlayerID.newBuilder().setPlayerID(playerId).build(), + Internal.observerMap(response, Alpha.Bool::getBool) + ); + } + + @Override + public void setPlayerCapacity(final long capacity, final StreamObserver response) { + this.alpha.setPlayerCapacity(Alpha.Count.newBuilder().setCount(capacity).build(), response); + } + + @Override + public void getPlayerCapacity(final StreamObserver response) { + this.alpha.getPlayerCapacity( + Alpha.Empty.getDefaultInstance(), + Internal.observerMap(response, Alpha.Count::getCount) + ); + } + + @Override + public void getPlayerCount(final StreamObserver response) { + this.alpha.getPlayerCount( + Alpha.Empty.getDefaultInstance(), + Internal.observerMap(response, Alpha.Count::getCount) + ); + } + + @Override + public void getList(final String name, final StreamObserver response) { + final Beta.GetListRequest request = Beta.GetListRequest.newBuilder().setName(name).build(); + this.beta.getList(request, Internal.observerMap(response, Internal::toList)); + } + + @Override + public void addList( + final String name, + final String value, + final StreamObserver response + ) { + final Beta.AddListValueRequest request = Beta.AddListValueRequest.newBuilder() + .setName(name) + .setValue(value) + .build(); + this.beta.addListValue(request, Internal.observerMap(response, Internal::toList)); + } + + @Override + public void removeList( + final String name, + final String value, + final StreamObserver response + ) { + final Beta.RemoveListValueRequest request = Beta.RemoveListValueRequest.newBuilder() + .setName(name) + .setValue(value) + .build(); + this.beta.removeListValue(request, Internal.observerMap(response, Internal::toList)); + } + + @Override + public void updateList( + final AgonesList list, + final List updateMask, + final StreamObserver response + ) { + final FieldMask mask = FieldMask.newBuilder().addAllPaths(updateMask).build(); + final Beta.UpdateListRequest request = Beta.UpdateListRequest.newBuilder() + .setList(Internal.toAgonesList(list)) + .setUpdateMask(mask) + .build(); + this.beta.updateList(request, Internal.observerMap(response, Internal::toList)); + } + + @Override + public void getCounter(final String name, final StreamObserver response) { + final Beta.GetCounterRequest request = Beta.GetCounterRequest.newBuilder() + .setName(name) + .build(); + this.beta.getCounter(request, Internal.observerMap(response, Internal::toCounter)); + } + + @Override + public void increaseCounter( + final String name, + final long amount, + final StreamObserver response + ) { + final Beta.CounterUpdateRequest update = Beta.CounterUpdateRequest.newBuilder() + .setName(name) + .setCountDiff(amount >= 0 ? amount : Math.abs(amount)) + .build(); + final Beta.UpdateCounterRequest request = Beta.UpdateCounterRequest.newBuilder() + .setCounterUpdateRequest(update) + .build(); + this.beta.updateCounter(request, Internal.observerMap(response, Internal::toCounter)); + } + + @Override + public void decreaseCounter( + final String name, + final long amount, + final StreamObserver response + ) { + final Beta.CounterUpdateRequest update = Beta.CounterUpdateRequest.newBuilder() + .setName(name) + .setCountDiff(amount >= 0 ? -amount : amount) + .build(); + final Beta.UpdateCounterRequest request = Beta.UpdateCounterRequest.newBuilder() + .setCounterUpdateRequest(update) + .build(); + this.beta.updateCounter(request, Internal.observerMap(response, Internal::toCounter)); + } + + @Override + public void setCounterCount( + final String name, + final long amount, + final StreamObserver response + ) { + final Beta.CounterUpdateRequest update = Beta.CounterUpdateRequest.newBuilder() + .setName(name) + .setCount(Int64Value.newBuilder().setValue(amount).build()) + .build(); + final Beta.UpdateCounterRequest request = Beta.UpdateCounterRequest.newBuilder() + .setCounterUpdateRequest(update) + .build(); + this.beta.updateCounter(request, Internal.observerMap(response, Internal::toCounter)); + } + + @Override + public void setCounterCapacity( + final String name, + final long amount, + final StreamObserver response + ) { + final Beta.CounterUpdateRequest update = Beta.CounterUpdateRequest.newBuilder() + .setName(name) + .setCapacity(Int64Value.newBuilder().setValue(amount).build()) + .build(); + final Beta.UpdateCounterRequest request = Beta.UpdateCounterRequest.newBuilder() + .setCounterUpdateRequest(update) + .build(); + this.beta.updateCounter(request, Internal.observerMap(response, Internal::toCounter)); + } + + @Override + public void close() throws Exception { + this.channel.shutdown().awaitTermination(5L, TimeUnit.SECONDS); + } + + static final class Builder implements Agones.Builder { + + private final ManagedChannel channel; + private final ExecutorService gameServerWatcherExecutor; + private final ScheduledExecutorService healthCheckExecutor; + private final Duration healthCheckDelay; + private final Duration healthCheckPeriod; + + private Builder( + final ManagedChannel channel, + final ExecutorService gameServerWatcherExecutor, + final ScheduledExecutorService healthCheckExecutor, + final Duration healthCheckDelay, + final Duration healthCheckPeriod + ) { + this.channel = channel; + this.gameServerWatcherExecutor = gameServerWatcherExecutor; + this.healthCheckExecutor = healthCheckExecutor; + this.healthCheckDelay = healthCheckDelay; + this.healthCheckPeriod = healthCheckPeriod; + } + + Builder() { + this(null, null, null, null, null); + } + + @Override + public Agones build() { + if (this.channel == null) { + return this.withChannel().build(); + } + return new AgonesImpl(this); + } + + @Override + public Agones.Builder withChannel(final ManagedChannel channel) { + return new Builder( + channel, + this.gameServerWatcherExecutor, + this.healthCheckExecutor, + this.healthCheckDelay, + this.healthCheckPeriod + ); + } + + @Override + public Agones.Builder withGameServerWatcherExecutor(final ExecutorService executor) { + return new Builder( + this.channel, + executor, + this.healthCheckExecutor, + this.healthCheckDelay, + this.healthCheckPeriod + ); + } + + @Override + public Agones.Builder withHealthCheck(final Duration delay, final Duration period) { + return new Builder( + this.channel, + this.gameServerWatcherExecutor, + this.healthCheckExecutor, + delay, + period + ); + } + + @Override + public Agones.Builder withHealthCheckExecutor(final ScheduledExecutorService executor) { + return new Builder( + this.channel, + this.gameServerWatcherExecutor, + executor, + this.healthCheckDelay, + this.healthCheckPeriod + ); + } + + private ScheduledExecutorService healthCheckExecutor() { + if (this.healthCheckExecutor != null) { + return this.healthCheckExecutor; + } + if (this.healthCheckDelay != null) { + return Executors.newSingleThreadScheduledExecutor(); + } + return null; + } + } +} diff --git a/src/main/java/net/infumia/agones4j/AgonesList.java b/src/main/java/net/infumia/agones4j/AgonesList.java new file mode 100644 index 0000000..ec491d9 --- /dev/null +++ b/src/main/java/net/infumia/agones4j/AgonesList.java @@ -0,0 +1,79 @@ +package net.infumia.agones4j; + +import java.util.Collections; +import java.util.List; +import java.util.Objects; +import java.util.StringJoiner; + +/** + * Represents a list in the Agones system. + */ +public final class AgonesList { + + private final String name; + private final long capacity; + private final List values; + + AgonesList(final String name, final long capacity, final List values) { + this.name = name; + this.capacity = capacity; + this.values = Collections.unmodifiableList(values); + } + + /** + * Retrieves the name of the list. + * + * @return The name. + */ + public String getName() { + return this.name; + } + + /** + * Retrieves the capacity of the list. + * + * @return The capacity. + */ + public long getCapacity() { + return this.capacity; + } + + /** + * Returns the values of the list. + * + * @return the values. + */ + public List getValues() { + return this.values; + } + + @Override + public boolean equals(final Object obj) { + if (this == obj) { + return true; + } + if (obj == null || this.getClass() != obj.getClass()) { + return false; + } + final AgonesList that = (AgonesList) obj; + return ( + Objects.equals(this.capacity, that.capacity) && + Objects.equals(this.name, that.name) && + Objects.equals(this.values, that.values) + ); + } + + @Override + public int hashCode() { + return Objects.hash(this.name, this.capacity, this.values); + } + + @Override + public String toString() { + return new StringJoiner(", ", AgonesList.class.getSimpleName() + "[", "]") + .add("name='" + this.name + "'") + .add("capacity=" + this.capacity) + .add("values=" + this.values) + .toString(); + } +} diff --git a/src/main/java/net/infumia/agones4j/Internal.java b/src/main/java/net/infumia/agones4j/Internal.java new file mode 100644 index 0000000..cc2af9e --- /dev/null +++ b/src/main/java/net/infumia/agones4j/Internal.java @@ -0,0 +1,181 @@ +package net.infumia.agones4j; + +import agones.dev.sdk.Sdk; +import agones.dev.sdk.beta.Beta; +import io.grpc.stub.StreamObserver; +import java.util.List; +import java.util.Objects; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.Executor; +import java.util.concurrent.atomic.AtomicReference; +import java.util.function.Consumer; +import java.util.function.Function; + +final class Internal { + + private static final int DEFAULT_GRPC_PORT = 9357; + private static final String DEFAULT_GRPC_HOST = "localhost"; + + private static final String ENV_GRPC_HOST = "AGONES_SDK_GRPC_HOST"; + private static final String ENV_GRPC_PORT = "AGONES_SDK_GRPC_PORT"; + private static final String ENV_GRPC_ADDRESS = "AGONES_SDK_GRPC_ADDRESS"; + + static final String GRPC_HOST = Internal.getEnv( + Internal.ENV_GRPC_HOST, + Internal.DEFAULT_GRPC_HOST + ); + static final int GRPC_PORT = Internal.getEnvAsInt( + Internal.ENV_GRPC_PORT, + Internal.DEFAULT_GRPC_PORT + ); + static final String GRPC_ADDRESS = Internal.getEnv(Internal.ENV_GRPC_ADDRESS, null); + + private static final StreamObserver EMPTY = new Adapter<>(); + + private Internal() { + throw new UnsupportedOperationException( + "This is a utility class and cannot be instantiated" + ); + } + + static AgonesCounter toCounter(final Beta.Counter counter) { + return new AgonesCounter(counter.getName(), counter.getCapacity(), counter.getCount()); + } + + static AgonesList toList(final Beta.List list) { + return new AgonesList(list.getName(), list.getCapacity(), list.getValuesList()); + } + + static Beta.List toAgonesList(final AgonesList list) { + return Beta.List.newBuilder() + .setName(list.getName()) + .setCapacity(list.getCapacity()) + .addAllValues(list.getValues()) + .build(); + } + + private static String getEnv(final String key, final String def) { + Objects.requireNonNull(key, "key"); + return Internal.getEnvOptional(key).orElse(def); + } + + private static int getEnvAsInt(final String key, final int def) { + Objects.requireNonNull(key, "key"); + return Internal.getEnvOptional(key).flatMap(Internal::parseInt).orElse(def); + } + + private static Optional getEnvOptional(final String key) { + Objects.requireNonNull(key, "key"); + return Optional.ofNullable(Internal.getEnv(key)); + } + + private static String getEnv(final String key) { + Objects.requireNonNull(key, "key"); + return System.getenv(key); + } + + private static Optional parseInt(final String text) { + Objects.requireNonNull(text, "text"); + try { + return Optional.of(Integer.parseInt(text)); + } catch (final Exception ignored) {} + return Optional.empty(); + } + + static StreamObserver observerEmpty() { + return Internal.EMPTY; + } + + static CompletableFuture observerToFuture(final Consumer> response) { + final CompletableFuture future = new CompletableFuture<>(); + response.accept(new Future<>(future)); + return future; + } + + static StreamObserver observerOnNext( + final Executor executor, + final List> consumers + ) { + return new Adapter() { + @Override + public void onNext(final T value) { + executor.execute(() -> { + for (final Consumer consumer : consumers) { + consumer.accept(value); + } + }); + } + }; + } + + static StreamObserver observerMap( + final StreamObserver observer, + final Function mapper + ) { + return new Mapped<>(observer, mapper); + } + + private static final class Mapped implements StreamObserver { + + private final StreamObserver observer; + private final Function mapper; + + private Mapped(final StreamObserver observer, final Function mapper) { + this.observer = observer; + this.mapper = mapper; + } + + @Override + public void onNext(final R value) { + this.observer.onNext(this.mapper.apply(value)); + } + + @Override + public void onError(final Throwable t) { + this.observer.onError(t); + } + + @Override + public void onCompleted() { + this.observer.onCompleted(); + } + } + + private static final class Future implements StreamObserver { + + private final AtomicReference value = new AtomicReference<>(); + private final CompletableFuture future; + + private Future(final CompletableFuture future) { + this.future = future; + } + + @Override + public void onNext(final T value) { + this.value.set(value); + } + + @Override + public void onError(final Throwable t) { + this.future.completeExceptionally(t); + } + + @Override + public void onCompleted() { + this.future.complete(this.value.get()); + } + } + + private static class Adapter implements StreamObserver { + + @Override + public void onNext(final T value) {} + + @Override + public void onError(final Throwable t) {} + + @Override + public void onCompleted() {} + } +} diff --git a/src/main/java/tr/com/infumia/agones4j/Agones.java b/src/main/java/tr/com/infumia/agones4j/Agones.java deleted file mode 100644 index 6441fcc..0000000 --- a/src/main/java/tr/com/infumia/agones4j/Agones.java +++ /dev/null @@ -1,854 +0,0 @@ -package tr.com.infumia.agones4j; - -import agones.dev.sdk.Sdk; -import agones.dev.sdk.alpha.Alpha; -import io.grpc.ManagedChannel; -import io.grpc.ManagedChannelBuilder; -import io.grpc.stub.StreamObserver; -import java.time.Duration; -import java.util.List; -import java.util.Objects; -import java.util.concurrent.CompletableFuture; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.ScheduledExecutorService; -import java.util.function.Consumer; - -/** - * The interface provides methods to interact with Agones. - */ -public interface Agones extends AutoCloseable { - /** - * Retrieves a new instance of the Agones builder. - * - * @return A new instance of the Agones builder. - */ - static Agones.Builder builder() { - return new AgonesImpl.Builder(); - } - - /** - * Checks if it can watch game server. - *

- * To enable game server watcher, use {@link Builder#withGameServerWatcherExecutor(ExecutorService)}. - * - * @return {@code true} if it can watch game server, {@code false} otherwise. - */ - boolean canWatchGameServer(); - - /** - * Adds a game server watcher. - *

- * Game server watchers are called whenever a game server event occurs. - * - * @param watcher A consumer that represents the game server watcher. - * - * @see #canWatchGameServer() - */ - void addGameServerWatcher(Consumer watcher); - - /** - * Checks if it can use health check system of Agones. - *

- * To enable health check, use {@link Builder#withHealthCheck(Duration, Duration)}. - * - * @return {@code true} if it can use health check system of Agones, {@code false} otherwise. - */ - boolean canHealthCheck(); - - /** - * Starts the health checking. - * - * @throws IllegalStateException if the health check interval not specified. - * @see #canHealthCheck() - */ - void startHealthChecking(); - - /** - * Stops the health checking. - */ - void stopHealthChecking(); - - /** - * Creates a new health check stream. - * - * @param response the response from server. - * - * @return a stream observer to send health check requests. - * - * @see #canHealthCheck() - */ - StreamObserver healthCheckStream(StreamObserver response); - - /** - * Creates a new health check stream. - * - * @return a stream observer to send health check requests. - * - * @see #canHealthCheck() - */ - default StreamObserver healthCheckStream() { - return this.healthCheckStream(Internal.observerEmpty()); - } - - /** - * Call to self Allocation the GameServer. - * - * @param response the response from server. - */ - void allocate(StreamObserver response); - - /** - * Call to self Allocation the GameServer. - */ - default void allocate() { - this.allocate(Internal.observerEmpty()); - } - - /** - * Call to self Allocation the GameServer. - * - * @return A future that represents the result of the allocation operation. - */ - default CompletableFuture allocateFuture() { - return Internal.observerToFuture(this::allocate); - } - - /** - * Retrieves the current GameServer data. - * - * @param response the response from server. - */ - void getGameServer(StreamObserver response); - - /** - * Retrieves the current GameServer data. - * - * @return A future that represents the current game server. - */ - default CompletableFuture getGameServerFuture() { - return Internal.observerToFuture(this::getGameServer); - } - - /** - * Call when the GameServer is ready. - * - * @param response the response from server. - */ - void ready(StreamObserver response); - - /** - * Call when the GameServer is ready. - */ - default void ready() { - this.ready(Internal.observerEmpty()); - } - - /** - * Call when the @link Sdk.GameServer is ready. - * - * @return A future that represents the result of the ready operation. - */ - default CompletableFuture readyFuture() { - return Internal.observerToFuture(this::ready); - } - - /** - * Marks the @link Sdk.GameServer as the Reserved state for Duration. - * - * @param duration the duration to mark. - * @param response the response from server. - */ - void reserve(Duration duration, StreamObserver response); - - /** - * Marks the @link Sdk.GameServer as the Reserved state for Duration. - * - * @param duration the duration to mark. - */ - default void reserve(final Duration duration) { - this.reserve(duration, Internal.observerEmpty()); - } - - /** - * Marks the @link Sdk.GameServer as the Reserved state for Duration. - * - * @param duration the duration to mark. - * - * @return A future that represents the result of the reserve operation. - */ - default CompletableFuture reserveFuture(final Duration duration) { - return Internal.observerToFuture(response -> this.reserve(duration, response)); - } - - /** - * Call when the @link Sdk.GameServer is shutting down. - * - * @param response the response from server. - */ - void shutdown(StreamObserver response); - - /** - * Call when the @link Sdk.GameServer is shutting down. - */ - default void shutdown() { - this.shutdown(Internal.observerEmpty()); - } - - /** - * Call when the @link Sdk.GameServer is shutting down. - * - * @return A future that represents the result of the shutdown operation. - */ - default CompletableFuture shutdownFuture() { - return Internal.observerToFuture(this::shutdown); - } - - /** - * Apply an Annotation to the backing @link Sdk.GameServer metadata. - * - * @param key the key to apply. - * @param value the value to apply. - * @param observer the observer to apply. - */ - void setAnnotation(String key, String value, StreamObserver observer); - - /** - * Apply an Annotation to the backing @link Sdk.GameServer metadata. - * - * @param key the key to apply. - * @param value the value to apply. - */ - default void setAnnotation(final String key, final String value) { - this.setAnnotation(key, value, Internal.observerEmpty()); - } - - /** - * Apply an Annotation to the backing @link Sdk.GameServer metadata. - * - * @param key the key to apply. - * @param value the value to apply. - * - * @return A future that represents the result of the set annotation operation. - */ - default CompletableFuture setAnnotationFuture(final String key, final String value) { - return Internal.observerToFuture(response -> this.setAnnotation(key, value, response)); - } - - /** - * Apply a Label to the backing @link Sdk.GameServer metadata. - * - * @param key the key to apply. - * @param value the value to apply. - * @param response the response from server. - */ - void setLabel(String key, String value, StreamObserver response); - - /** - * Apply a Label to the backing @link Sdk.GameServer metadata. - * - * @param key the key to apply. - * @param value the value to apply. - */ - default void setLabel(final String key, final String value) { - this.setLabel(key, value, Internal.observerEmpty()); - } - - /** - * Apply a Label to the backing @link Sdk.GameServer metadata. - * - * @param key the key to apply. - * @param value the value to apply. - * - * @return A future that represents the result of the set label operation. - */ - default CompletableFuture setLabelFuture(final String key, final String value) { - return Internal.observerToFuture(response -> this.setLabel(key, value, response)); - } - - /** - * Returns the list of the currently connected player ids. - *

- * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the - * @link Sdk.GameServer status resource. - *

- * If GameServer#Status#PlayerStatus#getIdsList is set manually through the Kubernetes API, use - * {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. - * - * @param response the response from server. - */ - void getConnectedPlayersFuture(StreamObserver> response); - - /** - * Returns the list of the currently connected player ids. - *

- * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the - * @link Sdk.GameServer status resource. - *

- * If GameServer#Status#PlayerStatus#getIdsList is set manually through the Kubernetes API, use - * {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. - * - * @return A future that represents the list of the currently connected player ids. - */ - default CompletableFuture> getConnectedPlayersFuture() { - return Internal.observerToFuture(this::getConnectedPlayersFuture); - } - - /** - * Increases the SDK’s stored player count by one, and appends this playerID to GameServer#Status#PlayerStatus#getIdsList. - *

- * GameServer#Status#PlayerStatus#getCount and GameServer#Status#PlayerStatus#getIdsList are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. - *

- * The response returns true and adds the playerID to the list of playerIDs if this playerID was not already in the list of connected playerIDs. - *

- * If the playerID exists within the list of connected playerIDs, will return false, and the list of connected playerIDs will be left unchanged. - *

- * An error will be returned if the playerID was not already in the list of connected playerIDs but the player capacity for the server has been reached. - * The playerID will not be added to the list of playerIDs. - *

- * WARNING: Do not use this method if you are manually managing GameServer#Status#PlayerStatus#getIdsList and GameServer#Status#PlayerStatus#getCount through the Kubernetes API, as indeterminate results will occur. - * - * @param playerId the player id to connect. - * @param response the response from server. - */ - void playerConnect(String playerId, StreamObserver response); - - /** - * Increases the SDK’s stored player count by one, and appends this playerID to GameServer#Status#PlayerStatus#getIdsList. - * GameServer#Status#PlayerStatus#getCount and GameServer#Status#PlayerStatus#getIdsList are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. - *

- * If the playerID exists within the list of connected playerIDs, will return false, and the list of connected playerIDs will be left unchanged. - *

- * An error will be returned if the playerID was not already in the list of connected playerIDs but the player capacity for the server has been reached. - * The playerID will not be added to the list of playerIDs. - *

- * WARNING: Do not use this method if you are manually managing GameServer#Status#PlayerStatus#getIdsList and GameServer#Status#PlayerStatus#getCount through the Kubernetes API, as indeterminate results will occur. - * - * @param playerId the player id to connect. - * - * @return A future that represents the result of the player connect operation. - */ - default CompletableFuture playerConnectFuture(final String playerId) { - return Internal.observerToFuture(response -> this.playerConnect(playerId, response)); - } - - /** - * Decreases the SDK’s stored player count by one, and removes the playerID from GameServer#Status#PlayerStatus#getIdsList - * GameServer#Status#PlayerStatus#getCount and GameServer#Status#PlayerStatus#getIdsList are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. - *

- * The response returns true and removes the playerID from the list of connected playerIDs if the playerID value exists within the list. - *

- * If the playerID was not in the list of connected playerIDs, the call will return false, and the connected playerID list will be left unchanged. - *

- * WARNING: Do not use this method if you are manually managing GameServer#Status#PlayerStatus#getIdsList and GameServer#Status#PlayerStatus#getCount through the Kubernetes API, as indeterminate results will occur. - * - * @param playerId the player id to disconnect. - * @param response the response from server. - */ - void playerDisconnect(String playerId, StreamObserver response); - - /** - * Decreases the SDK’s stored player count by one, and removes the playerID from GameServer#Status#PlayerStatus#getIdsList - * GameServer#Status#PlayerStatus#getCount and GameServer#Status#PlayerStatus#getIdsList are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. - *

- * If the playerID was not in the list of connected playerIDs, the call will return false, and the connected playerID list will be left unchanged. - *

- * WARNING: Do not use this method if you are manually managing GameServer#Status#PlayerStatus#getIdsList and GameServer#Status#PlayerStatus#getCount through the Kubernetes API, as indeterminate results will occur. - * - * @param playerId the player id to disconnect. - * - * @return A future that represents the result of the player disconnect operation. - */ - default CompletableFuture playerDisconnectFuture(final String playerId) { - return Internal.observerToFuture(response -> this.playerDisconnect(playerId, response)); - } - - /** - * Returns if the playerID is currently connected to the @link Sdk.GameServer. - *

- * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. - *

- * If GameServer#Status#PlayerStatus#getIdsList is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to determine connected status. - * - * @param playerId the player id to return. - * @param response the response from server. - */ - void isPlayerConnected(String playerId, StreamObserver response); - - /** - * Returns if the playerID is currently connected to the @link Sdk.GameServer. - *

- * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. - *

- * If GameServer#Status#PlayerStatus#getIdsList is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to determine connected status. - * - * @param playerId the player id to return. - * - * @return A future that represents the result of the is player connected operation. - */ - default CompletableFuture isPlayerConnected(final String playerId) { - return Internal.observerToFuture(response -> this.isPlayerConnected(playerId, response)); - } - - /** - * Update the GameServer#Status#PlayerStatus#getCapacity value with a new capacity. - * - * @param capacity the capacity to update. - * @param response the response from server. - */ - void setPlayerCapacity(long capacity, StreamObserver response); - - /** - * Update the GameServer#Status#PlayerStatus#getCapacity value with a new capacity. - * - * @param capacity the capacity to update. - * - * @return A future that represents the result of the set player capacity operation. - */ - default CompletableFuture setPlayerCapacityFuture(final long capacity) { - return Internal.observerToFuture(response -> this.setPlayerCapacity(capacity, response)); - } - - /** - * Retrieves the current player capacity. - *

- * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. - *

- * If GameServer#Status#PlayerStatus#getCapacity is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. - * - * @param response the response from server. - */ - void getPlayerCapacity(StreamObserver response); - - /** - * Retrieves the current player capacity. - *

- * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. - *

- * If GameServer#Status#PlayerStatus#getCapacity is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. - * - * @return A future that represents the current player capacity. - */ - default CompletableFuture getPlayerCapacityFuture() { - return Internal.observerToFuture(this::getPlayerCapacity); - } - - /** - * Retrieves the current player count. - *

- * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. - *

- * If GameServer#Status#PlayerStatus#getCount is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. - * - * @param response the response from server. - */ - void getPlayerCount(StreamObserver response); - - /** - * Retrieves the current player count. - *

- * This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the @link Sdk.GameServer status resource. - *

- * If GameServer#Status#PlayerStatus#getCount is set manually through the Kubernetes API, use {@link Agones#getGameServerFuture()} or {@link Agones#addGameServerWatcher(Consumer)} instead to view this value. - * - * @return A future that represents the current player count. - */ - default CompletableFuture getPlayerCountFuture() { - return Internal.observerToFuture(this::getPlayerCount); - } - - /** - * gets a list. - *

- * returns NOT_FOUND if the List does not exist. - * - * @param name the name to get. - * @param response the response from server. - */ - void getList(String name, StreamObserver response); - - /** - * gets a list. - *

- * Returns NOT_FOUND if the List does not exist. - * - * @param name the name to get. - * - * @return the list. - */ - default CompletableFuture getList(final String name) { - return Internal.observerToFuture(response -> this.getList(name, response)); - } - - /** - * Adds a value to a list and returns updated list. - *

- * Returns NOT_FOUND if the list does not exist. - *

- * Returns ALREADY_EXISTS if the value is already in the list. - *

- * Returns OUT_OF_RANGE if the list is already at Capacity. - * - * @param name the name to add. - * @param value the value to add. - * @param response the response from server. - */ - void addList(String name, String value, StreamObserver response); - - /** - * Adds a value to a list and returns updated list. - *

- * Returns NOT_FOUND if the list does not exist. - *

- * Returns ALREADY_EXISTS if the value is already in the list. - *

- * Returns OUT_OF_RANGE if the list is already at Capacity. - * - * @param name the name to add. - * @param value the value to add. - * - * @return the updated list. - */ - default CompletableFuture addListFuture(final String name, final String value) { - return Internal.observerToFuture(response -> this.addList(name, value, response)); - } - - /** - * Removes a value from a list and returns updated list. - *

- * Returns NOT_FOUND if the list does not exist. - *

- * Returns NOT_FOUND if the value is not in the list. - * - * @param name the name to remove. - * @param value the value to remove. - * @param response the response from server. - */ - void removeList(String name, String value, StreamObserver response); - - /** - * Removes a value from a list and returns updated list. - *

- * Returns NOT_FOUND if the list does not exist. - *

- * Returns NOT_FOUND if the value is not in the list. - * - * @param name the name to remove. - * @param value the value to remove. - * - * @return the updated list. - */ - default CompletableFuture removeListFuture(final String name, final String value) { - return Internal.observerToFuture(response -> this.removeList(name, value, response)); - } - - /** - * Returns the updated list. - *

- * Returns NOT_FOUND if the list does not exist (name cannot be updated). - *

- * THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES. - *

- * Use {@link #addListFuture(String, String)} or {@link #removeListFuture(String, String)} for modifying the - * List.Values field. - *

- * Returns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the list. - * - * @param list the list to update. - * @param updateMask the update mask to update. - * @param response the response from server. - */ - void updateList(AgonesList list, List updateMask, StreamObserver response); - - /** - * Returns the updated list. - *

- * Returns NOT_FOUND if the list does not exist (name cannot be updated). - *

- * THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES. - *

- * Use {@link #addListFuture(String, String)} or {@link #removeListFuture(String, String)} for modifying the - * List.Values field. - *

- * Returns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the list. - * - * @param list the list to update. - * @param updateMask the update mask to update. - * - * @return the updated list. - */ - default CompletableFuture updateList(final AgonesList list, final List updateMask) { - return Internal.observerToFuture(response -> this.updateList(list, updateMask, response)); - } - - /** - * gets a counter. - *

- * Returns NOT_FOUND if the counter does not exist. - * - * @param name the name of the counter. - * @param response the response from server. - */ - void getCounter(String name, StreamObserver response); - - /** - * gets a counter. - *

- * Returns NOT_FOUND if the counter does not exist. - * - * @param name the name of the counter. - * - * @return the counter. - */ - default CompletableFuture getCounterFuture(final String name) { - return Internal.observerToFuture(response -> this.getCounter(name, response)); - } - - /** - * Increases the count of the Counter by the specified amount. - *

- * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - *

- * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. - * - * @param name the name of the counter. - * @param amount the amount to increase. - * @param response the response from server. - */ - void increaseCounter(String name, long amount, StreamObserver response); - - /** - * Increases the count of the Counter by the specified amount. - *

- * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - *

- * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. - * - * @param name the name of the counter. - * @param amount the amount to increase. - * - * @return the counter. - */ - default CompletableFuture increaseCounterFuture(final String name, final long amount) { - return Internal.observerToFuture(response -> this.increaseCounter(name, amount, response)); - } - - /** - * Decreases the count of the Counter by the specified amount. - *

- * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - *

- * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. - * - * @param name the name of the counter. - * @param amount the amount to decrease. - * @param response the response from server. - */ - void decreaseCounter(String name, long amount, StreamObserver response); - - /** - * Decreases the count of the Counter by the specified amount. - *

- * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - *

- * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. - * - * @param name the name of the counter. - * @param amount the amount to decrease. - * - * @return the counter. - */ - default CompletableFuture decreaseCounter(final String name, final long amount) { - return Internal.observerToFuture(response -> this.decreaseCounter(name, amount, response)); - } - - /** - * Sets the count of the Counter by the specified amount. - *

- * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - *

- * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. - * - * @param name the name of the counter. - * @param amount the amount to set. - * @param response the response from server. - */ - void setCounterCount(String name, long amount, StreamObserver response); - - /** - * Sets the count of the Counter by the specified amount. - *

- * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - *

- * Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. - * - * @param name the name of the counter. - * @param amount the amount to set. - * - * @return the counter. - */ - default CompletableFuture setCounterCountFuture(String name, long amount) { - return Internal.observerToFuture(response -> this.setCounterCount(name, amount, response)); - } - - /** - * Sets the capacity of the Counter by the specified amount. - *

- * 0 is no limit. - *

- * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - * - * @param name the name of the counter. - * @param amount the amount to set. - * @param response the response from server. - */ - void setCounterCapacity(String name, long amount, StreamObserver response); - - /** - * Sets the capacity of the Counter by the specified amount. - *

- * 0 is no limit. - *

- * Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - * - * @param name the name of the counter. - * @param amount the amount to set. - * - * @return the counter. - */ - default CompletableFuture setCounterCapacityFuture(final String name, final long amount) { - return Internal.observerToFuture(response -> this.setCounterCapacity(name, amount, response)); - } - - /** - * A builder for creating instances of Agones with specified configurations. - */ - interface Builder { - /** - * Builds an instance of Agones using the specified configuration. - * - * @return An instance of Agones. - */ - Agones build(); - - /** - * Sets the address for the Agones Builder. - * - * @param host The host address to be set. - * @param port The port number to be set. - * - * @return The Agones Builder instance. - * - * @see ManagedChannelBuilder#forAddress(String, int) - * @see ManagedChannelBuilder#usePlaintext() - */ - default Builder withAddress(final String host, final int port) { - return this.withChannel(ManagedChannelBuilder.forAddress(host, port).usePlaintext().build()); - } - - /** - * Sets the address for the Agones Builder. - * - * @param host The host address to be set. - * - * @return The Agones Builder instance. - */ - default Builder withAddress(final String host) { - return this.withAddress(host, Internal.GRPC_PORT); - } - - /** - * Sets the address for the Agones Builder. - * - * @param port The port number to be set. - * - * @return The Agones Builder instance. - */ - default Builder withAddress(final int port) { - return this.withAddress(Internal.GRPC_HOST, port); - } - - /** - * Sets the address for the Agones Builder. - * - * @return The Agones Builder instance. - */ - default Builder withAddress() { - return this.withAddress(Internal.GRPC_HOST); - } - - /** - * Sets the target for the Agones Builder. - * - * @param target The target to be set. - * - * @return The Agones Builder instance. - * - * @see ManagedChannelBuilder#forTarget(String) - * @see ManagedChannelBuilder#usePlaintext() - */ - default Builder withTarget(final String target) { - return this.withChannel(ManagedChannelBuilder.forTarget(target).usePlaintext().build()); - } - - /** - * Sets the target for the Agones Builder. - * - * @return The Agones Builder instance. - */ - default Builder withTarget() { - Objects.requireNonNull(Internal.GRPC_ADDRESS, "Environment variable 'AGONES_SDK_GRPC_ADDRESS' is not set!"); - return this.withTarget(Internal.GRPC_ADDRESS); - } - - /** - * Sets the channel from environment variables for the Agones Builder. - * - * @return The Agones Builder instance. - */ - default Builder withChannel() { - if (Internal.GRPC_ADDRESS == null) { - return this.withAddress(); - } else { - return this.withTarget(); - } - } - - /** - * Sets the ManagedChannel for the Agones Builder. - * - * @param channel The ManagedChannel to be set. - * - * @return The Agones Builder instance. - */ - Builder withChannel(ManagedChannel channel); - - /** - * Sets the executor for the game server watcher. - * - * @param executor The executor service to be used by the game server watcher. {@code null} to disable it. Disabled by default. - * - * @return The Agones Builder instance. - */ - Builder withGameServerWatcherExecutor(ExecutorService executor); - - /** - * Sets the health check interval for the Agones Builder. - * - * @param delay The delay duration for health checks. {@code null} to disable it. Disabled by default. - * @param period The interval duration for health checks. - * - * @return The Agones Builder instance. - */ - Builder withHealthCheck(Duration delay, Duration period); - - /** - * Sets the health check executor for the builder. - * - * @param executor the scheduled executor service to be used for health checks. {@code null} to disable it. Default is {@link Executors#newSingleThreadScheduledExecutor()} - * - * @return The Agones Builder instance. - */ - Builder withHealthCheckExecutor(ScheduledExecutorService executor); - } -} diff --git a/src/main/java/tr/com/infumia/agones4j/AgonesCounter.java b/src/main/java/tr/com/infumia/agones4j/AgonesCounter.java deleted file mode 100644 index 275af7f..0000000 --- a/src/main/java/tr/com/infumia/agones4j/AgonesCounter.java +++ /dev/null @@ -1,77 +0,0 @@ -package tr.com.infumia.agones4j; - -import java.util.Objects; -import java.util.StringJoiner; - -/** - * Represents a counter in the Agones system. - */ -public final class AgonesCounter { - - private final String name; - private final long capacity; - private final long count; - - AgonesCounter(final String name, final long capacity, final long count) { - this.name = name; - this.capacity = capacity; - this.count = count; - } - - /** - * Retrieves the counter name. - * - * @return the name. - */ - public String getName() { - return this.name; - } - - /** - * Retrieves the counter capacity. - * - * @return the capacity. - */ - public long getCapacity() { - return this.capacity; - } - - /** - * Returns the counter count. - * - * @return the count. - */ - public long getCount() { - return this.count; - } - - @Override - public boolean equals(final Object obj) { - if (this == obj) { - return true; - } - if (obj == null || this.getClass() != obj.getClass()) { - return false; - } - final AgonesCounter that = (AgonesCounter) obj; - return ( - Objects.equals(this.capacity, that.capacity) && - Objects.equals(this.name, that.name) && - Objects.equals(this.count, that.count) - ); - } - - @Override - public int hashCode() { - return Objects.hash(this.name, this.capacity, this.count); - } - - @Override - public String toString() { - return new StringJoiner(", ", AgonesCounter.class.getSimpleName() + "[", "]") - .add("name='" + this.name + "'") - .add("capacity=" + this.capacity) - .add("count=" + this.count) - .toString(); - } -} diff --git a/src/main/java/tr/com/infumia/agones4j/AgonesImpl.java b/src/main/java/tr/com/infumia/agones4j/AgonesImpl.java deleted file mode 100644 index d6414df..0000000 --- a/src/main/java/tr/com/infumia/agones4j/AgonesImpl.java +++ /dev/null @@ -1,382 +0,0 @@ -package tr.com.infumia.agones4j; - -import agones.dev.sdk.Sdk; -import agones.dev.sdk.alpha.Alpha; -import com.google.protobuf.FieldMask; -import com.google.protobuf.Int64Value; -import io.grpc.ManagedChannel; -import io.grpc.stub.StreamObserver; -import java.time.Duration; -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; -import java.util.Objects; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.ScheduledExecutorService; -import java.util.concurrent.ScheduledFuture; -import java.util.concurrent.TimeUnit; -import java.util.function.Consumer; - -final class AgonesImpl implements Agones { - - private final ManagedChannel channel; - - private final agones.dev.sdk.SDKGrpc.SDKStub sdk; - private final agones.dev.sdk.beta.SDKGrpc.SDKStub beta; - private final agones.dev.sdk.alpha.SDKGrpc.SDKStub alpha; - - private final ExecutorService gameServerWatcherExecutor; - private List> gameServerWatchers; - - private final Duration healthCheckDelay; - private final ScheduledExecutorService healthCheckExecutor; - private final Duration healthCheckPeriod; - private ScheduledFuture healthCheckTask; - - private AgonesImpl(final Builder builder) { - this.channel = builder.channel; - this.gameServerWatcherExecutor = builder.gameServerWatcherExecutor; - this.healthCheckExecutor = builder.healthCheckExecutor(); - this.healthCheckDelay = builder.healthCheckDelay; - this.healthCheckPeriod = builder.healthCheckPeriod; - this.sdk = agones.dev.sdk.SDKGrpc.newStub(builder.channel); - this.beta = agones.dev.sdk.beta.SDKGrpc.newStub(builder.channel); - this.alpha = agones.dev.sdk.alpha.SDKGrpc.newStub(builder.channel); - } - - @Override - public boolean canWatchGameServer() { - return this.gameServerWatcherExecutor != null; - } - - @Override - public void addGameServerWatcher(final Consumer watcher) { - Objects.requireNonNull(this.gameServerWatcherExecutor, "Game server watcher is not enabled!"); - if (this.gameServerWatchers == null) { - this.gameServerWatchers = Collections.synchronizedList(new ArrayList<>()); - final StreamObserver response = Internal.observerOnNext( - this.gameServerWatcherExecutor, - this.gameServerWatchers - ); - this.sdk.watchGameServer(Sdk.Empty.getDefaultInstance(), response); - } - this.gameServerWatchers.add(watcher); - } - - @Override - public boolean canHealthCheck() { - return this.healthCheckExecutor != null && this.healthCheckDelay != null && this.healthCheckPeriod != null; - } - - @Override - public void startHealthChecking() { - if (this.healthCheckExecutor == null || this.healthCheckDelay == null || this.healthCheckPeriod == null) { - throw new IllegalStateException("Health check is not enabled!"); - } - if (this.healthCheckTask != null) { - this.healthCheckTask.cancel(true); - } - final StreamObserver request = this.healthCheckStream(Internal.observerEmpty()); - this.healthCheckTask = - this.healthCheckExecutor.scheduleAtFixedRate( - () -> { - if (this.healthCheckTask != null && !this.healthCheckTask.isDone()) { - request.onNext(Sdk.Empty.getDefaultInstance()); - } - }, - this.healthCheckDelay.toMillis(), - this.healthCheckPeriod.toMillis(), - TimeUnit.MILLISECONDS - ); - } - - @Override - public void stopHealthChecking() { - if (this.healthCheckTask != null) { - this.healthCheckTask.cancel(true); - this.healthCheckTask = null; - } - } - - @Override - public StreamObserver healthCheckStream(final StreamObserver response) { - return this.sdk.health(response); - } - - @Override - public void allocate(final StreamObserver response) { - this.sdk.allocate(Sdk.Empty.getDefaultInstance(), response); - } - - @Override - public void getGameServer(final StreamObserver response) { - this.sdk.getGameServer(Sdk.Empty.getDefaultInstance(), response); - } - - @Override - public void ready(final StreamObserver response) { - this.sdk.ready(Sdk.Empty.getDefaultInstance(), response); - } - - @Override - public void reserve(final Duration duration, final StreamObserver response) { - this.sdk.reserve(Sdk.Duration.newBuilder().setSeconds(duration.getSeconds()).build(), response); - } - - @Override - public void shutdown(final StreamObserver response) { - this.sdk.shutdown(Sdk.Empty.getDefaultInstance(), response); - } - - @Override - public void setAnnotation(final String key, final String value, final StreamObserver observer) { - this.sdk.setAnnotation(Sdk.KeyValue.newBuilder().setKey(key).setValue(value).build(), observer); - } - - @Override - public void setLabel(final String key, final String value, final StreamObserver response) { - this.sdk.setLabel(Sdk.KeyValue.newBuilder().setKey(key).setValue(value).build(), response); - } - - @Override - public void getConnectedPlayersFuture(final StreamObserver> response) { - this.alpha.getConnectedPlayers( - Alpha.Empty.getDefaultInstance(), - Internal.observerMap(response, Alpha.PlayerIDList::getListList) - ); - } - - @Override - public void playerConnect(final String playerId, final StreamObserver response) { - this.alpha.playerConnect( - Alpha.PlayerID.newBuilder().setPlayerID(playerId).build(), - Internal.observerMap(response, Alpha.Bool::getBool) - ); - } - - @Override - public void playerDisconnect(final String playerId, final StreamObserver response) { - this.alpha.playerDisconnect( - Alpha.PlayerID.newBuilder().setPlayerID(playerId).build(), - Internal.observerMap(response, Alpha.Bool::getBool) - ); - } - - @Override - public void isPlayerConnected(final String playerId, final StreamObserver response) { - this.alpha.isPlayerConnected( - Alpha.PlayerID.newBuilder().setPlayerID(playerId).build(), - Internal.observerMap(response, Alpha.Bool::getBool) - ); - } - - @Override - public void setPlayerCapacity(final long capacity, final StreamObserver response) { - this.alpha.setPlayerCapacity(Alpha.Count.newBuilder().setCount(capacity).build(), Internal.observerEmptyAlpha()); - } - - @Override - public void getPlayerCapacity(final StreamObserver response) { - this.alpha.getPlayerCapacity( - Alpha.Empty.getDefaultInstance(), - Internal.observerMap(response, Alpha.Count::getCount) - ); - } - - @Override - public void getPlayerCount(final StreamObserver response) { - this.alpha.getPlayerCount(Alpha.Empty.getDefaultInstance(), Internal.observerMap(response, Alpha.Count::getCount)); - } - - @Override - public void getList(final String name, final StreamObserver response) { - final Alpha.GetListRequest request = Alpha.GetListRequest.newBuilder().setName(name).build(); - this.alpha.getList(request, Internal.observerMap(response, Internal::toList)); - } - - @Override - public void addList(final String name, final String value, final StreamObserver response) { - final Alpha.AddListValueRequest request = Alpha.AddListValueRequest - .newBuilder() - .setName(name) - .setValue(value) - .build(); - this.alpha.addListValue(request, Internal.observerMap(response, Internal::toList)); - } - - @Override - public void removeList(final String name, final String value, final StreamObserver response) { - final Alpha.RemoveListValueRequest request = Alpha.RemoveListValueRequest - .newBuilder() - .setName(name) - .setValue(value) - .build(); - this.alpha.removeListValue(request, Internal.observerMap(response, Internal::toList)); - } - - @Override - public void updateList( - final AgonesList list, - final List updateMask, - final StreamObserver response - ) { - final FieldMask mask = FieldMask.newBuilder().addAllPaths(updateMask).build(); - final Alpha.UpdateListRequest request = Alpha.UpdateListRequest - .newBuilder() - .setList(Internal.toAgonesList(list)) - .setUpdateMask(mask) - .build(); - this.alpha.updateList(request, Internal.observerMap(response, Internal::toList)); - } - - @Override - public void getCounter(final String name, final StreamObserver response) { - final Alpha.GetCounterRequest request = Alpha.GetCounterRequest.newBuilder().setName(name).build(); - this.alpha.getCounter(request, Internal.observerMap(response, Internal::toCounter)); - } - - @Override - public void increaseCounter(final String name, final long amount, final StreamObserver response) { - final Alpha.CounterUpdateRequest update = Alpha.CounterUpdateRequest - .newBuilder() - .setName(name) - .setCountDiff(amount >= 0 ? amount : Math.abs(amount)) - .build(); - final Alpha.UpdateCounterRequest request = Alpha.UpdateCounterRequest - .newBuilder() - .setCounterUpdateRequest(update) - .build(); - this.alpha.updateCounter(request, Internal.observerMap(response, Internal::toCounter)); - } - - @Override - public void decreaseCounter(final String name, final long amount, final StreamObserver response) { - final Alpha.CounterUpdateRequest update = Alpha.CounterUpdateRequest - .newBuilder() - .setName(name) - .setCountDiff(amount >= 0 ? -amount : amount) - .build(); - final Alpha.UpdateCounterRequest request = Alpha.UpdateCounterRequest - .newBuilder() - .setCounterUpdateRequest(update) - .build(); - this.alpha.updateCounter(request, Internal.observerMap(response, Internal::toCounter)); - } - - @Override - public void setCounterCount(final String name, final long amount, final StreamObserver response) { - final Alpha.CounterUpdateRequest update = Alpha.CounterUpdateRequest - .newBuilder() - .setName(name) - .setCount(Int64Value.newBuilder().setValue(amount).build()) - .build(); - final Alpha.UpdateCounterRequest request = Alpha.UpdateCounterRequest - .newBuilder() - .setCounterUpdateRequest(update) - .build(); - this.alpha.updateCounter(request, Internal.observerMap(response, Internal::toCounter)); - } - - @Override - public void setCounterCapacity(final String name, final long amount, final StreamObserver response) { - final Alpha.CounterUpdateRequest update = Alpha.CounterUpdateRequest - .newBuilder() - .setName(name) - .setCapacity(Int64Value.newBuilder().setValue(amount).build()) - .build(); - final Alpha.UpdateCounterRequest request = Alpha.UpdateCounterRequest - .newBuilder() - .setCounterUpdateRequest(update) - .build(); - this.alpha.updateCounter(request, Internal.observerMap(response, Internal::toCounter)); - } - - @Override - public void close() throws Exception { - this.channel.shutdown().awaitTermination(5L, TimeUnit.SECONDS); - } - - static final class Builder implements Agones.Builder { - - private final ManagedChannel channel; - private final ExecutorService gameServerWatcherExecutor; - private final ScheduledExecutorService healthCheckExecutor; - private final Duration healthCheckDelay; - private final Duration healthCheckPeriod; - - private Builder( - final ManagedChannel channel, - final ExecutorService gameServerWatcherExecutor, - final ScheduledExecutorService healthCheckExecutor, - final Duration healthCheckDelay, - final Duration healthCheckPeriod - ) { - this.channel = channel; - this.gameServerWatcherExecutor = gameServerWatcherExecutor; - this.healthCheckExecutor = healthCheckExecutor; - this.healthCheckDelay = healthCheckDelay; - this.healthCheckPeriod = healthCheckPeriod; - } - - Builder() { - this(null, null, null, null, null); - } - - @Override - public Agones build() { - if (this.channel == null) { - return this.withChannel().build(); - } - return new AgonesImpl(this); - } - - @Override - public Agones.Builder withChannel(final ManagedChannel channel) { - return new Builder( - channel, - this.gameServerWatcherExecutor, - this.healthCheckExecutor, - this.healthCheckDelay, - this.healthCheckPeriod - ); - } - - @Override - public Agones.Builder withGameServerWatcherExecutor(final ExecutorService executor) { - return new Builder( - this.channel, - executor, - this.healthCheckExecutor, - this.healthCheckDelay, - this.healthCheckPeriod - ); - } - - @Override - public Agones.Builder withHealthCheck(final Duration delay, final Duration period) { - return new Builder(this.channel, this.gameServerWatcherExecutor, this.healthCheckExecutor, delay, period); - } - - @Override - public Agones.Builder withHealthCheckExecutor(final ScheduledExecutorService executor) { - return new Builder( - this.channel, - this.gameServerWatcherExecutor, - executor, - this.healthCheckDelay, - this.healthCheckPeriod - ); - } - - private ScheduledExecutorService healthCheckExecutor() { - if (this.healthCheckExecutor != null) { - return this.healthCheckExecutor; - } - if (this.healthCheckDelay != null) { - return Executors.newSingleThreadScheduledExecutor(); - } - return null; - } - } -} diff --git a/src/main/java/tr/com/infumia/agones4j/AgonesList.java b/src/main/java/tr/com/infumia/agones4j/AgonesList.java deleted file mode 100644 index 5cc7667..0000000 --- a/src/main/java/tr/com/infumia/agones4j/AgonesList.java +++ /dev/null @@ -1,79 +0,0 @@ -package tr.com.infumia.agones4j; - -import java.util.Collections; -import java.util.List; -import java.util.Objects; -import java.util.StringJoiner; - -/** - * Represents a list in the Agones system. - */ -public final class AgonesList { - - private final String name; - private final long capacity; - private final List values; - - AgonesList(final String name, final long capacity, final List values) { - this.name = name; - this.capacity = capacity; - this.values = Collections.unmodifiableList(values); - } - - /** - * Retrieves the name of the list. - * - * @return The name. - */ - public String getName() { - return this.name; - } - - /** - * Retrieves the capacity of the list. - * - * @return The capacity. - */ - public long getCapacity() { - return this.capacity; - } - - /** - * Returns the values of the list. - * - * @return the values. - */ - public List getValues() { - return this.values; - } - - @Override - public boolean equals(final Object obj) { - if (this == obj) { - return true; - } - if (obj == null || this.getClass() != obj.getClass()) { - return false; - } - final AgonesList that = (AgonesList) obj; - return ( - Objects.equals(this.capacity, that.capacity) && - Objects.equals(this.name, that.name) && - Objects.equals(this.values, that.values) - ); - } - - @Override - public int hashCode() { - return Objects.hash(this.name, this.capacity, this.values); - } - - @Override - public String toString() { - return new StringJoiner(", ", AgonesList.class.getSimpleName() + "[", "]") - .add("name='" + this.name + "'") - .add("capacity=" + this.capacity) - .add("values=" + this.values) - .toString(); - } -} diff --git a/src/main/java/tr/com/infumia/agones4j/Internal.java b/src/main/java/tr/com/infumia/agones4j/Internal.java deleted file mode 100644 index 0950825..0000000 --- a/src/main/java/tr/com/infumia/agones4j/Internal.java +++ /dev/null @@ -1,173 +0,0 @@ -package tr.com.infumia.agones4j; - -import agones.dev.sdk.Sdk; -import agones.dev.sdk.alpha.Alpha; -import io.grpc.stub.StreamObserver; -import java.util.List; -import java.util.Objects; -import java.util.Optional; -import java.util.concurrent.CompletableFuture; -import java.util.concurrent.Executor; -import java.util.concurrent.atomic.AtomicReference; -import java.util.function.Consumer; -import java.util.function.Function; - -final class Internal { - - private static final int DEFAULT_GRPC_PORT = 9357; - private static final String DEFAULT_GRPC_HOST = "localhost"; - - private static final String ENV_GRPC_HOST = "AGONES_SDK_GRPC_HOST"; - private static final String ENV_GRPC_PORT = "AGONES_SDK_GRPC_PORT"; - private static final String ENV_GRPC_ADDRESS = "AGONES_SDK_GRPC_ADDRESS"; - - static final String GRPC_HOST = Internal.getEnv(Internal.ENV_GRPC_HOST, Internal.DEFAULT_GRPC_HOST); - static final int GRPC_PORT = Internal.getEnvAsInt(Internal.ENV_GRPC_PORT, Internal.DEFAULT_GRPC_PORT); - static final String GRPC_ADDRESS = Internal.getEnv(Internal.ENV_GRPC_ADDRESS, null); - - private static final StreamObserver EMPTY = new Adapter<>(); - private static final StreamObserver EMPTY_ALPHA = new Adapter<>(); - - private Internal() { - throw new UnsupportedOperationException("This is a utility class and cannot be instantiated"); - } - - static AgonesCounter toCounter(final Alpha.Counter counter) { - return new AgonesCounter(counter.getName(), counter.getCapacity(), counter.getCount()); - } - - static AgonesList toList(final Alpha.List list) { - return new AgonesList(list.getName(), list.getCapacity(), list.getValuesList()); - } - - static Alpha.List toAgonesList(final AgonesList list) { - return Alpha.List - .newBuilder() - .setName(list.getName()) - .setCapacity(list.getCapacity()) - .addAllValues(list.getValues()) - .build(); - } - - private static String getEnv(final String key, final String def) { - Objects.requireNonNull(key, "key"); - return Internal.getEnvOptional(key).orElse(def); - } - - private static int getEnvAsInt(final String key, final int def) { - Objects.requireNonNull(key, "key"); - return Internal.getEnvOptional(key).flatMap(Internal::parseInt).orElse(def); - } - - private static Optional getEnvOptional(final String key) { - Objects.requireNonNull(key, "key"); - return Optional.ofNullable(Internal.getEnv(key)); - } - - private static String getEnv(final String key) { - Objects.requireNonNull(key, "key"); - return System.getenv(key); - } - - private static Optional parseInt(final String text) { - Objects.requireNonNull(text, "text"); - try { - return Optional.of(Integer.parseInt(text)); - } catch (final Exception ignored) {} - return Optional.empty(); - } - - static StreamObserver observerEmpty() { - return Internal.EMPTY; - } - - static StreamObserver observerEmptyAlpha() { - return Internal.EMPTY_ALPHA; - } - - static CompletableFuture observerToFuture(final Consumer> response) { - final CompletableFuture future = new CompletableFuture<>(); - response.accept(new Future<>(future)); - return future; - } - - static StreamObserver observerOnNext(final Executor executor, final List> consumers) { - return new Adapter() { - @Override - public void onNext(final T value) { - executor.execute(() -> { - for (final Consumer consumer : consumers) { - consumer.accept(value); - } - }); - } - }; - } - - static StreamObserver observerMap(final StreamObserver observer, final Function mapper) { - return new Mapped<>(observer, mapper); - } - - private static final class Mapped implements StreamObserver { - - private final StreamObserver observer; - private final Function mapper; - - private Mapped(final StreamObserver observer, final Function mapper) { - this.observer = observer; - this.mapper = mapper; - } - - @Override - public void onNext(final R value) { - this.observer.onNext(this.mapper.apply(value)); - } - - @Override - public void onError(final Throwable t) { - this.observer.onError(t); - } - - @Override - public void onCompleted() { - this.observer.onCompleted(); - } - } - - private static final class Future implements StreamObserver { - - private final AtomicReference value = new AtomicReference<>(); - private final CompletableFuture future; - - private Future(final CompletableFuture future) { - this.future = future; - } - - @Override - public void onNext(final T value) { - this.value.set(value); - } - - @Override - public void onError(final Throwable t) { - this.future.completeExceptionally(t); - } - - @Override - public void onCompleted() { - this.future.complete(this.value.get()); - } - } - - private static class Adapter implements StreamObserver { - - @Override - public void onNext(final T value) {} - - @Override - public void onError(final Throwable t) {} - - @Override - public void onCompleted() {} - } -} diff --git a/src/main/proto/allocation/allocation.proto b/src/main/proto/allocation/allocation.proto index b180296..6e4ff0b 100644 --- a/src/main/proto/allocation/allocation.proto +++ b/src/main/proto/allocation/allocation.proto @@ -79,13 +79,22 @@ message AllocationRequest { // Note: This field can only be set if neither Required or Preferred is set. repeated GameServerSelector gameServerSelectors = 8; - // (Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most - // important for sorting. The allocator will use the first priority for sorting GameServers in the - // Selector set, and will only use any following priority for tie-breaking during sort. - // Impacts which GameServer is checked first. + // [Stage: Beta] + // [FeatureFlag:CountsAndLists] + // `Priorities` configuration alters the order in which `GameServers` are searched for matches to the configured `selectors`. + // + // Priority of sorting is in descending importance. I.e. The position 0 `priority` entry is checked first. + // + // For `Packed` strategy sorting, this priority list will be the tie-breaker within the least utilised infrastructure, to ensure optimal + // infrastructure usage while also allowing some custom prioritisation of `GameServers`. + // + // For `Distributed` strategy sorting, the entire selection of `GameServers` will be sorted by this priority list to provide the + // order that `GameServers` will be allocated by. repeated Priority priorities = 9; - // (Alpha, CountsAndLists feature flag) Counters and Lists provide a set of actions to perform + // [Stage: Beta] + // [FeatureFlag:CountsAndLists] + // Counters and Lists provide a set of actions to perform // on Counters and Lists during allocation. map counters = 10; map lists = 11; @@ -105,6 +114,10 @@ message AllocationResponse { string source = 6; optional GameServerMetadata metadata = 7; + // (Beta, CountsAndLists feature flag) Status of Counters and Lists on allocation. + map counters = 9; + map lists = 10; + // The gameserver port info that is allocated. message GameServerStatusPort { string name = 1; @@ -121,6 +134,16 @@ message AllocationResponse { map labels = 1; map annotations = 2; } + + message CounterStatus { + google.protobuf.Int64Value count = 1; + google.protobuf.Int64Value capacity = 2; + } + + message ListStatus { + repeated string values = 1; + google.protobuf.Int64Value capacity = 2; + } } // Specifies settings for multi-cluster allocation. diff --git a/src/main/proto/sdk/alpha/alpha.proto b/src/main/proto/sdk/alpha/alpha.proto index 1f4cc33..37cc475 100644 --- a/src/main/proto/sdk/alpha/alpha.proto +++ b/src/main/proto/sdk/alpha/alpha.proto @@ -18,11 +18,6 @@ package agones.dev.sdk.alpha; option go_package = "./alpha"; import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/empty.proto"; -import "google/protobuf/field_mask.proto"; import "google/protobuf/wrappers.proto"; import "grpc-gateway/protoc-gen-openapiv2/options/annotations.proto"; @@ -128,65 +123,6 @@ service SDK { get: "/alpha/player/connected" }; } - - // Gets a Counter. Returns NOT_FOUND if the Counter does not exist. - rpc GetCounter(GetCounterRequest) returns (Counter) { - option (google.api.http) = { - get: "/v1alpha1/counters/{name}" - }; - option (google.api.method_signature) = "name"; - } - - // UpdateCounter returns the updated Counter. Returns NOT_FOUND if the Counter does not exist (name cannot be updated). - // Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. - rpc UpdateCounter(UpdateCounterRequest) returns (Counter) { - option (google.api.http) = { - patch: "/v1alpha1/counters/{counterUpdateRequest.name}" - body: "counterUpdateRequest" - }; - option (google.api.method_signature) = "counterUpdateRequest"; - } - - // Gets a List. Returns NOT_FOUND if the List does not exist. - rpc GetList(GetListRequest) returns (List) { - option (google.api.http) = { - get: "/v1alpha1/lists/{name}" - }; - option (google.api.method_signature) = "name"; - } - - // UpdateList returns the updated List. Returns NOT_FOUND if the List does not exist (name cannot be updated). - // **THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES** - // Use AddListValue() or RemoveListValue() for modifying the List.Values field. - // Returns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the List. - // If a field mask path(s) is specified, but the value is not set in the request List object, - // then the default value for the variable will be set (i.e. 0 for "capacity", empty list for "values"). - rpc UpdateList(UpdateListRequest) returns (List) { - option (google.api.http) = { - patch: "/v1alpha1/lists/{list.name}" - body: "list" - }; - option (google.api.method_signature) = "list,update_mask"; - } - - // Adds a value to a List and returns updated List. Returns NOT_FOUND if the List does not exist. - // Returns ALREADY_EXISTS if the value is already in the List. - // Returns OUT_OF_RANGE if the List is already at Capacity. - rpc AddListValue(AddListValueRequest) returns (List) { - option (google.api.http) = { - post: "/v1alpha1/lists/{name}:addValue" - body: "*" - }; - } - - // Removes a value from a List and returns updated List. Returns NOT_FOUND if the List does not exist. - // Returns NOT_FOUND if the value is not in the List. - rpc RemoveListValue(RemoveListValueRequest) returns (List) { - option (google.api.http) = { - post: "/v1alpha1/lists/{name}:removeValue" - body: "*" - }; - } } // I am Empty @@ -212,111 +148,3 @@ message PlayerID { message PlayerIDList { repeated string list = 1; } - -// A representation of a Counter. -message Counter { - option (google.api.resource) = { - type: "agones.dev/Counter" - pattern: "counters/{counter}" - }; - // The name of the Counter - string name = 1; - // The current count of the Counter - int64 count = 2; - // The maximum capacity of the Counter - int64 capacity = 3; -} - -// A representation of a Counter Update Request. -message CounterUpdateRequest { - option (google.api.resource) = { - type: "agones.dev/CounterUpdateRequest" - pattern: "counterUpdateRequests/{counterUpdateRequest}" - }; - // The name of the Counter to update - string name = 1; - // The value to set the Counter Count - google.protobuf.Int64Value count = 2; - // The value to set the Counter Capacity - google.protobuf.Int64Value capacity = 3; - // countDiff tracks if a Counter Update Request is CountIncrement (positive), CountDecrement - // (negative), 0 if a CountSet or CapacitySet request - int64 countDiff = 4; -} - -message GetCounterRequest { - // The name of the Counter to get - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "agones.dev/Counter" - }]; -} - -message UpdateCounterRequest { - // The requested update to make to the Counter - CounterUpdateRequest counterUpdateRequest = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "agones.dev/CounterUpdateRequest" - }]; -} - -// A representation of a List. -message List { - option (google.api.resource) = { - type: "agones.dev/List" - pattern: "lists/{list}" - }; - // The name of the List - string name = 1; - // The maximum capacity of the List - int64 capacity = 2; - // The array of items in the List ["v1", "v2", …] - repeated string values = 3; -} - -message GetListRequest { - // The name of the List to get - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "agones.dev/List" - }]; -} - -message UpdateListRequest { - // The List to update - List list = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "agones.dev/List" - }]; - - // Required. Mask (list) of fields to update. - // Fields are specified relative to the List - // (e.g. `capacity`, `values`; *not* `List.capacity` or `List.values`). - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; -} - -message AddListValueRequest { - // The name of the List to add a value to. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "agones.dev/List" - }]; - - string value = 2 [(google.api.field_behavior) = REQUIRED]; -} - -message RemoveListValueRequest { - // The name of the List to remove a value from. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "agones.dev/List" - }]; - - string value = 2 [(google.api.field_behavior) = REQUIRED]; -} diff --git a/src/main/proto/sdk/beta/beta.proto b/src/main/proto/sdk/beta/beta.proto index 02ec501..30b3bf8 100644 --- a/src/main/proto/sdk/beta/beta.proto +++ b/src/main/proto/sdk/beta/beta.proto @@ -18,6 +18,12 @@ package agones.dev.sdk.beta; option go_package = "./beta"; import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/protobuf/empty.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/wrappers.proto"; import "grpc-gateway/protoc-gen-openapiv2/options/annotations.proto"; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { @@ -31,4 +37,175 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { }; // SDK service to be used in the GameServer SDK to the Pod Sidecar -service SDK {} +service SDK { + // Gets a Counter. Returns NOT_FOUND if the Counter does not exist. + rpc GetCounter(GetCounterRequest) returns (Counter) { + option (google.api.http) = { + get: "/v1beta1/counters/{name}" + }; + option (google.api.method_signature) = "name"; + } + + // UpdateCounter returns the updated Counter. Returns NOT_FOUND if the Counter does not exist (name cannot be updated). + // Returns OUT_OF_RANGE if the Count is out of range [0,Capacity]. + rpc UpdateCounter(UpdateCounterRequest) returns (Counter) { + option (google.api.http) = { + patch: "/v1beta1/counters/{counterUpdateRequest.name}" + body: "counterUpdateRequest" + }; + option (google.api.method_signature) = "counterUpdateRequest"; + } + + // Gets a List. Returns NOT_FOUND if the List does not exist. + rpc GetList(GetListRequest) returns (List) { + option (google.api.http) = { + get: "/v1beta1/lists/{name}" + }; + option (google.api.method_signature) = "name"; + } + + // UpdateList returns the updated List. Returns NOT_FOUND if the List does not exist (name cannot be updated). + // **THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES** + // Use AddListValue() or RemoveListValue() for modifying the List.Values field. + // Returns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the List. + // If a field mask path(s) is specified, but the value is not set in the request List object, + // then the default value for the variable will be set (i.e. 0 for "capacity", empty list for "values"). + rpc UpdateList(UpdateListRequest) returns (List) { + option (google.api.http) = { + patch: "/v1beta1/lists/{list.name}" + body: "list" + }; + option (google.api.method_signature) = "list,update_mask"; + } + + // Adds a value to a List and returns updated List. Returns NOT_FOUND if the List does not exist. + // Returns ALREADY_EXISTS if the value is already in the List. + // Returns OUT_OF_RANGE if the List is already at Capacity. + rpc AddListValue(AddListValueRequest) returns (List) { + option (google.api.http) = { + post: "/v1beta1/lists/{name}:addValue" + body: "*" + }; + } + + // Removes a value from a List and returns updated List. Returns NOT_FOUND if the List does not exist. + // Returns NOT_FOUND if the value is not in the List. + rpc RemoveListValue(RemoveListValueRequest) returns (List) { + option (google.api.http) = { + post: "/v1beta1/lists/{name}:removeValue" + body: "*" + }; + } +} + +// I am Empty +message Empty { +} + +// A representation of a Counter. +message Counter { + option (google.api.resource) = { + type: "agones.dev/Counter" + pattern: "counters/{counter}" + }; + // The name of the Counter + string name = 1; + // The current count of the Counter + int64 count = 2; + // The maximum capacity of the Counter + int64 capacity = 3; +} + +// A representation of a Counter Update Request. +message CounterUpdateRequest { + option (google.api.resource) = { + type: "agones.dev/CounterUpdateRequest" + pattern: "counterUpdateRequests/{counterUpdateRequest}" + }; + // The name of the Counter to update + string name = 1; + // The value to set the Counter Count + google.protobuf.Int64Value count = 2; + // The value to set the Counter Capacity + google.protobuf.Int64Value capacity = 3; + // countDiff tracks if a Counter Update Request is CountIncrement (positive), CountDecrement + // (negative), 0 if a CountSet or CapacitySet request + int64 countDiff = 4; +} + +message GetCounterRequest { + // The name of the Counter to get + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "agones.dev/Counter" + }]; +} + +message UpdateCounterRequest { + // The requested update to make to the Counter + CounterUpdateRequest counterUpdateRequest = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "agones.dev/CounterUpdateRequest" + }]; +} + +// A representation of a List. +message List { + option (google.api.resource) = { + type: "agones.dev/List" + pattern: "lists/{list}" + }; + // The name of the List + string name = 1; + // The maximum capacity of the List + int64 capacity = 2; + // The array of items in the List ["v1", "v2", …] + repeated string values = 3; +} + +message GetListRequest { + // The name of the List to get + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "agones.dev/List" + }]; +} + +message UpdateListRequest { + // The List to update + List list = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "agones.dev/List" + }]; + + // Required. Mask (list) of fields to update. + // Fields are specified relative to the List + // (e.g. `capacity`, `values`; *not* `List.capacity` or `List.values`). + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; +} + +message AddListValueRequest { + // The name of the List to add a value to. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "agones.dev/List" + }]; + + string value = 2 [(google.api.field_behavior) = REQUIRED]; +} + +message RemoveListValueRequest { + // The name of the List to remove a value from. + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "agones.dev/List" + }]; + + string value = 2 [(google.api.field_behavior) = REQUIRED]; +} \ No newline at end of file diff --git a/src/main/proto/sdk/sdk.proto b/src/main/proto/sdk/sdk.proto index 9f5ff68..50c9335 100644 --- a/src/main/proto/sdk/sdk.proto +++ b/src/main/proto/sdk/sdk.proto @@ -167,14 +167,14 @@ message GameServer { repeated string ids = 3; } - // [Stage:Alpha] + // [Stage:Beta] // [FeatureFlag:CountsAndLists] message CounterStatus { int64 count = 1; int64 capacity = 2; } - // [Stage:Alpha] + // [Stage:Beta] // [FeatureFlag:CountsAndLists] message ListStatus { int64 capacity = 1; @@ -190,11 +190,11 @@ message GameServer { // [FeatureFlag:PlayerTracking] PlayerStatus players = 4; - // [Stage:Alpha] + // [Stage:Beta] // [FeatureFlag:CountsAndLists] map counters = 5; - // [Stage:Alpha] + // [Stage:Beta] // [FeatureFlag:CountsAndLists] map lists = 6; }