Use Protobuf/gRPC for JSON (de)serialization

* Switch to GRPC

* Make all tests pass

* Deprecate app ID/secret usage

* Make solution moderation work

* Change GRPC files location

* Clean prints, comments, catch-prints

* Fix pmd static analysis failure

* Upgrade gradle

* Add JDK11 to Travis

* Upgrade grpc and protobuf-java-util

* Add annotation compileOnly dependency

* Extract all dependency version to one place

* Remove kotlin dependency

* Spelling fix

* Upgrade all dependencies to latest version

* Fix autoValue version

* Remove sourceSet commented code

* Deploy after finishing JDK11 run

* Allow deploying alpha prereleases

Author: rok-povsic

.travis.yml

@@ -1,7 +1,7 @@
 branches:
   only:
     - master
-    - /^\d+\.\d+\.\d+$/
+    - /^\d+\.\d+\.\d+(-\w+\d*)*$/
 
 sudo: true
 
@@ -10,6 +10,7 @@ language: java
 jdk:
   - oraclejdk8
   - oraclejdk9
+  - oraclejdk11
 
 before_cache:
   - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
@@ -23,14 +24,15 @@ cache:
 
 before_deploy:
   - openssl aes-256-cbc -K $encrypted_fe71053f5cc2_key -iv $encrypted_fe71053f5cc2_iv -in gradle.properties.enc -out gradle.properties -d
+  - IS_ALPHA=false; if [[ $TRAVIS_TAG == *"alpha"* ]]; then IS_ALPHA=true; fi
 
 deploy:
   - provider: script
     script:
       - ./gradlew bintrayUpload
     skip_cleanup: true
     on:
-      jdk: oraclejdk9
+      jdk: oraclejdk11
       tags: true
       repo: Clarifai/clarifai-java
   - provider: releases
@@ -40,6 +42,7 @@ deploy:
     file:
       - core/build/libs/core-*.jar
     on:
-      jdk: oraclejdk9
+      jdk: oraclejdk11
       tags: true
       repo: Clarifai/clarifai-java
+    prerelease: $IS_ALPHA

build.gradle

@@ -41,25 +41,26 @@ subprojects {
   }
 
   ext.versions = [
-      okhttp: "3.4.1",
-      gson: "2.7",
       autoValue: "1.5.2",
-      slf4j: "1.7.21",
-      kotlin: "1.0.5-2",
-
+      autoValueWith: "1.0.0",
       customHashCodeEquals: "db3442d",
+      grpc: "1.17.1",
+      gson: "2.8.5",
+      javaxAnnotationApi: "1.3.2",
+      okhttp: "3.12.0",
+      protobuf: "3.6.1",
+      protobufJavaUtil: "3.6.1",
+
+      junit: "4.12",
+      junitRetryRule: "cbdd972",
+      slf4j: "1.7.21",
   ]
 
   ext.deps = [
-      nullityAnnotations: "org.jetbrains:annotations:13.0",
-      kotlin: [
-          stdlib: "org.jetbrains.kotlin:kotlin-stdlib:$versions.kotlin",
-          reflect: "org.jetbrains.kotlin:kotlin-reflect:$versions.kotlin",
-          gradlePlugin: "org.jetbrains.kotlin:kotlin-gradle-plugin:$versions.kotlin",
-      ],
+      nullityAnnotations: "org.jetbrains:annotations:16.0.3",
   ]
 }
 
 task wrapper(type: Wrapper) {
-  gradleVersion = "4.3.1"
+  gradleVersion = "4.10.3"
 }

core/build.gradle

@@ -6,17 +6,24 @@ dependencies {
   compile(
       "com.squareup.okhttp3:okhttp:$versions.okhttp",
       "com.google.code.gson:gson:$versions.gson",
+      "com.google.protobuf:protobuf-java:$versions.protobuf",
+
+      "io.grpc:grpc-netty-shaded:$versions.grpc",
+      "io.grpc:grpc-protobuf:$versions.grpc",
+      "io.grpc:grpc-stub:$versions.grpc",
+      "com.google.protobuf:protobuf-java-util:$versions.protobufJavaUtil",
   )
 
   compileOnly(
       "com.google.auto.value:auto-value:$versions.autoValue",
       deps.nullityAnnotations,
       "com.github.kevinmost.auto-value-custom-hashcode-equals:adapter:$versions.customHashCodeEquals",
+      "javax.annotation:javax.annotation-api:$versions.javaxAnnotationApi",
   )
 
   apt(
       "com.google.auto.value:auto-value:$versions.autoValue",
-      "com.gabrielittner.auto.value:auto-value-with:1.0.0",
+      "com.gabrielittner.auto.value:auto-value-with:$versions.autoValueWith",
       "com.github.kevinmost.auto-value-custom-hashcode-equals:processor:$versions.customHashCodeEquals",
   )
 }

core/src/main/java/clarifai2/api/BaseClarifaiClient.java

@@ -1,32 +1,25 @@
 package clarifai2.api;
 
 import clarifai2.BuildConfig;
-import clarifai2.exception.ClarifaiException;
+import clarifai2.exception.ClarifaiClientClosedException;
+import clarifai2.exception.DeprecationException;
 import clarifai2.internal.AutoValueTypeAdapterFactory;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonDeserializationContext;
 import com.google.gson.JsonDeserializer;
 import com.google.gson.JsonElement;
-import com.google.gson.JsonObject;
 import okhttp3.Cache;
-import okhttp3.Credentials;
 import okhttp3.HttpUrl;
 import okhttp3.Interceptor;
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
-import okhttp3.RequestBody;
 import okhttp3.Response;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.io.IOException;
 import java.lang.reflect.Type;
-import java.util.Collections;
-import java.util.concurrent.Callable;
-import java.util.concurrent.ExecutionException;
-
-import static clarifai2.internal.InternalUtil.MEDIA_TYPE_JSON;
 
 public abstract class BaseClarifaiClient implements ClarifaiClient {
 
@@ -39,33 +32,13 @@ public abstract class BaseClarifaiClient implements ClarifaiClient {
   @NotNull
   public final HttpUrl baseURL;
 
-  @Nullable
-  private final String appID;
-
-  @Nullable
-  private final String appSecret;
-
   @Nullable
   private final String apiKey;
 
-  @NotNull
-  private final OkHttpClient tokenRefreshHTTPClient;
-
-  @Nullable
-  private ClarifaiToken currentClarifaiToken = null;
-
   private boolean closed = false;
 
   BaseClarifaiClient(@NotNull ClarifaiBuilder builder) {
-    if (builder.apiKey == null) {
-      this.appID = notNullOrThrow(builder.appID, "appID cannot be null if apiKey is null");
-      this.appSecret = notNullOrThrow(builder.appSecret, "appSecret cannot be null if apiKey is null");
-      this.apiKey = null;
-    } else {
-      this.apiKey = builder.apiKey;
-      this.appID = null;
-      this.appSecret = null;
-    }
+    this.apiKey = builder.apiKey;
 
     this.gson = vendGson();
 
@@ -79,26 +52,12 @@ public Response intercept(Chain chain) throws IOException {
         final Request.Builder requestBuilder = chain.request().newBuilder()
             .header("X-Clarifai-Client", String.format("java:%s:%s", BuildConfig.VERSION, System.getProperty("java.version", "?")));
         if (closed) {
-          throw new ClarifaiException("This " + ClarifaiClient.class.getSimpleName() + " has already been closed");
-        }
-        if (apiKey == null) {
-          final ClarifaiToken credential = refreshIfNeeded();
-          if (credential != null) {
-            requestBuilder.addHeader("Authorization", "Bearer " + credential.getAccessToken());
-          }
-          return chain.proceed(requestBuilder.build());
-        } else {
-          requestBuilder.addHeader("Authorization", "Key " + apiKey);
-          return chain.proceed(requestBuilder.build());
+          throw new ClarifaiClientClosedException("This " + ClarifaiClient.class.getSimpleName() + " has already been closed");
         }
+        requestBuilder.addHeader("Authorization", "Key " + apiKey);
+        return chain.proceed(requestBuilder.build());
       }
     }).build();
-
-    this.tokenRefreshHTTPClient = unmodifiedClient.newBuilder().build();
-
-    if (apiKey == null) {
-      refreshIfNeeded();
-    }
   }
 
   private static void closeOkHttpClient(@NotNull OkHttpClient client) {
@@ -114,68 +73,17 @@ private static void closeOkHttpClient(@NotNull OkHttpClient client) {
   }
 
   @Override public boolean hasValidToken() {
-    return currentClarifaiToken != null && System.currentTimeMillis() <= currentClarifaiToken.getExpiresAt();
+    throw new DeprecationException(
+        "Using app ID/secret is deprecated, and the hasValidToken method as well. Please switch to using API key. "
+            + "See here how: http://help.clarifai.com/api/account-related/all-about-api-keys"
+    );
   }
 
   @NotNull @Override public ClarifaiToken getToken() throws IllegalStateException {
-    if (!hasValidToken()) {
-      throw new IllegalStateException("No valid token in this " + ClarifaiClient.class.getSimpleName() + ". "
-          + "Use hasValidToken() to check if a token exists before invoking this method to avoid this exception.");
-    }
-    //noinspection ConstantConditions
-    return currentClarifaiToken;
-  }
-
-  @Nullable
-  private ClarifaiToken refreshIfNeeded() {
-    synchronized (this) {
-      if (!hasValidToken()) {
-        currentClarifaiToken = refresh();
-      }
-      return currentClarifaiToken;
-    }
-  }
-
-  @Nullable
-  private ClarifaiToken refresh() {
-    try {
-      return tokenRefreshHTTPClient.dispatcher().executorService().invokeAny(Collections.singletonList(
-          new Callable<ClarifaiToken>() {
-            @Override public ClarifaiToken call() throws Exception {
-              final Response tokenResponse = tokenRefreshHTTPClient.newCall(new Request.Builder()
-                  .url(baseURL.newBuilder().addPathSegments("v2/token").build())
-                  .header("Authorization", Credentials.basic(appID, appSecret))
-                  .header("X-Clarifai-Client", "java:" + BuildConfig.VERSION)
-                  .post(RequestBody.create(MEDIA_TYPE_JSON, "\"grant_type\":\"client_credentials\""))
-                  .build()
-              ).execute();
-              if (tokenResponse.isSuccessful()) {
-                final JsonObject response = gson.fromJson(tokenResponse.body().string(), JsonObject.class);
-                return new ClarifaiToken(response.get("access_token").getAsString(),
-                    response.get("expires_in").getAsInt()
-                );
-              } else if (tokenResponse.code() == 401) {
-                throw new ClarifaiException("Clarifai app ID and/or app secret are incorrect");
-              }
-              return null;
-            }
-          }
-      ));
-    } catch (InterruptedException | ExecutionException e) {
-      final Throwable cause = e.getCause();
-      if (cause instanceof ClarifaiException) {
-        throw ((ClarifaiException) cause);
-      }
-      return null;
-    }
-  }
-
-  @NotNull
-  private static <T> T notNullOrThrow(@Nullable T check, String errorMsg) {
-    if (check == null) {
-      throw new IllegalArgumentException(errorMsg);
-    }
-    return check;
+    throw new DeprecationException(
+        "Using app ID/secret is deprecated, and the getToken method as well. Please switch to using API key. "
+            + "See here how: http://help.clarifai.com/api/account-related/all-about-api-keys"
+    );
   }
 
   @NotNull
@@ -194,8 +102,6 @@ public ClarifaiClient deserialize(JsonElement json, Type typeOfT, JsonDeserializ
 
   @Override public void close() {
     closed = true;
-    closeOkHttpClient(tokenRefreshHTTPClient);
     closeOkHttpClient(httpClient);
   }
 }
-

core/src/main/java/clarifai2/api/ClarifaiBuilder.java

@@ -1,9 +1,9 @@
 package clarifai2.api;
 
+import clarifai2.exception.DeprecationException;
 import okhttp3.HttpUrl;
 import okhttp3.OkHttpClient;
 import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
 
 import java.net.URL;
 import java.util.List;
@@ -14,13 +14,7 @@
 
 public final class ClarifaiBuilder {
 
-  @Nullable
-  final String appID;
-
-  @Nullable
-  final String appSecret;
-
-  @Nullable
+  @NotNull
   final String apiKey;
 
   @NotNull
@@ -30,15 +24,14 @@ public final class ClarifaiBuilder {
   HttpUrl baseURL = HttpUrl.parse("https://api.clarifai.com");
 
   public ClarifaiBuilder(@NotNull String appID, @NotNull String appSecret) {
-    this.appID = appID;
-    this.appSecret = appSecret;
-    this.apiKey = null;
+    throw new DeprecationException(
+        "Using app ID/secret is deprecated. Please switch to using API key. See here how: " +
+            "http://help.clarifai.com/api/account-related/all-about-api-keys"
+    );
   }
 
   public ClarifaiBuilder(@NotNull String apiKey) {
     this.apiKey = apiKey;
-    this.appID = null;
-    this.appSecret = null;
   }
 
   @NotNull