feat (thrift deprecation)!: replace thrift entities with internal ones (cadence-workflow#1022)

What changed?

Migration Guide

To construct GRPC Workflow Service use new WorkflowServiceGrpc() instead of new Thrift2ProtoAdapter(IGrpcServiceStubs.newInstance());
Removed TException and now all workflow service method returns CadenceError instead;
Replaced thrift generated entities with internal entities (Currently still generated from thrift files but no longer has runtime dependency on thrift);
Removed support for thrift entities in default data converter;
Why?

Java thrift deprecation

How did you test it?

Unit Test

Author: shijiesheng

.github/workflows/release.yml

@@ -24,22 +24,6 @@ jobs:
           java-version: '11'
           distribution: 'temurin'
           cache: 'gradle'
-      - name: Install necessary tooling
-        env:
-          APACHE_THRIFT_VERSION: 0.9.3
-        run: |
-          apt-get update && apt-get install -y wget gcc make build-essential git
-
-          wget https://archive.apache.org/dist/thrift/${APACHE_THRIFT_VERSION}/thrift-${APACHE_THRIFT_VERSION}.tar.gz && \
-          tar -xvf thrift-${APACHE_THRIFT_VERSION}.tar.gz && \
-          rm thrift-${APACHE_THRIFT_VERSION}.tar.gz && \
-          cd thrift-${APACHE_THRIFT_VERSION}/ && \
-          ./configure --enable-libs=no --enable-tests=no --enable-tutorial=no --with-cpp=no --with-c_glib=no --with-java=yes --with-ruby=no --with-erlang=no --with-go=no --with-nodejs=no --with-python=no && \
-          make && \
-          make install && \
-          cd .. && \
-          rm -rf thrift-${APACHE_THRIFT_VERSION}
-
       - name: Determine release version
         id: vars
         run: |

build.gradle

@@ -1,6 +1,5 @@
 buildscript {
     dependencies {
-        classpath "gradle.plugin.org.jruyi.gradle:thrift-gradle-plugin:0.4.1"
         classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.11'
     }
 }
@@ -34,7 +33,6 @@ repositories {
 apply plugin: 'com.google.protobuf'
 apply plugin: 'idea' // IntelliJ plugin to see files generated from protos
 apply plugin: 'maven'
-apply plugin: 'org.jruyi.thrift'
 apply plugin: 'maven-publish'
 apply plugin: 'com.github.sherter.google-java-format'
 
@@ -44,7 +42,7 @@ googleJavaFormat {
     exclude '**/generated-sources/*'
 }
 
-tasks.googleJavaFormat.dependsOn 'license'
+tasks.googleJavaFormat.dependsOn 'licenseFormat'
 
 group = 'com.uber.cadence'
 
@@ -77,7 +75,6 @@ dependencies {
 
     compile group: 'com.uber.tchannel', name: 'tchannel-core', version: '0.8.30'
     compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.36'
-    compile group: 'org.apache.thrift', name: 'libthrift', version: '0.9.3'
     compile group: 'com.google.code.gson', name: 'gson', version: '2.10'
     compile group: 'com.uber.m3', name: 'tally-core', version: '0.11.1'
     compile group: 'com.google.guava', name: 'guava', version: '31.1-jre'
@@ -89,6 +86,10 @@ dependencies {
     compile group: 'com.google.api.grpc', name: 'proto-google-common-protos', version: '2.10.0'
     compile group: 'com.google.protobuf', name: 'protobuf-java-util', version: '3.21.9'
     compile group: 'com.google.oauth-client', name: 'google-oauth-client', version: '1.35.0'
+    compileOnly 'org.projectlombok:lombok:1.18.30'
+    annotationProcessor 'org.projectlombok:lombok:1.18.30'
+    testCompileOnly 'org.projectlombok:lombok:1.18.30'
+    testAnnotationProcessor 'org.projectlombok:lombok:1.18.30'
 
     implementation 'io.grpc:grpc-netty-shaded:1.54.2'
     implementation 'io.grpc:grpc-protobuf:1.54.2'
@@ -126,19 +127,14 @@ task updateDlsSubmodule(type: Exec) {
     commandLine 'git', 'submodule', 'update'
 }
 
-compileThrift {
-    dependsOn updateDlsSubmodule
-    verbose true
-    sourceItems "${projectDir}/src/main/idls/thrift/cadence.thrift","${projectDir}/src/main/idls/thrift/shared.thrift","${projectDir}/src/main/idls/thrift/shadower.thrift"
-}
-
 sourceSets {
     main {
         proto {
             srcDir 'src/main/idls/proto'
         }
         java {
             srcDir 'src/main'
+            srcDir 'src/gen/java'
         }
     }
 }

docker/github_actions/Dockerfile

@@ -3,28 +3,10 @@
 # commits to that branch and one of them can break the build
 FROM adoptopenjdk/openjdk11:jdk-11.0.10_9-alpine
 
-# Apache Thrift version
-ENV APACHE_THRIFT_VERSION=0.9.3
-
 # Install dependencies using apk
-RUN apk update && apk add --virtual wget ca-certificates wget && apk add --virtual build-dependencies build-base gcc
+RUN apk update && apk add --virtual wget ca-certificates wget
 # Git is needed in order to update the dls submodule
 RUN apk add git libstdc++ bash curl
 
-# Compile source
-RUN set -ex ;\
-	wget https://archive.apache.org/dist/thrift/${APACHE_THRIFT_VERSION}/thrift-${APACHE_THRIFT_VERSION}.tar.gz && \
-	tar -xvf thrift-${APACHE_THRIFT_VERSION}.tar.gz && \
-	rm thrift-${APACHE_THRIFT_VERSION}.tar.gz && \
-	cd thrift-${APACHE_THRIFT_VERSION}/ && \
-	./configure --enable-libs=no --enable-tests=no --enable-tutorial=no --with-cpp=no --with-c_glib=no --with-java=yes --with-ruby=no --with-erlang=no --with-go=no --with-nodejs=no --with-python=no && \
-	make && \
-	make install && \
-	cd .. && \
-	rm -rf thrift-${APACHE_THRIFT_VERSION}
-
-# Cleanup packages and remove cache
-RUN apk del build-dependencies wget && rm -rf /var/cache/apk/*
-
 RUN mkdir /cadence-java-client
 WORKDIR /cadence-java-client

scripts/install-thrift-locally-osx.sh

@@ -19,6 +19,7 @@ const (
 type Field struct {
 	Name string
 	Type string
+	Initializer string
 }
 
 type TemplateEntity struct {
@@ -119,9 +120,22 @@ func (g *Generator) generateStruct(v *ast.Struct, outputDir string, packageName
 			return fmt.Errorf("failed to map field type: %w", err)
 		}
 
+		initializer := ""
+		switch field.Type.(type) {
+		case ast.SetType:
+			initializer = " = new HashSet<>();"
+		case ast.ListType:
+			initializer = " = new ArrayList<>();"
+		case ast.MapType:
+			initializer = " = new HashMap<>();"
+		}
+
+		fmt.Println(field.Name, initializer, typeStr)
+
 		fields = append(fields, Field{
 			Name: field.Name,
 			Type: typeStr,
+			Initializer: initializer,
 		})
 	}
 

scripts/v4_entity_generator/generator.go

@@ -11,6 +11,6 @@ import {{.}};
 @Accessors(chain = true)
 public class {{.ClassName}} {
   {{- range .Fields}}
-  private {{.Type}} {{.Name}};
+  private {{.Type}} {{.Name}}{{.Initializer}};
   {{- end}}
 }

scripts/v4_entity_generator/template/java_struct.tmpl

@@ -7,5 +7,5 @@
 @Data
 @Accessors(chain = true)
 public class BadBinaries {
-  private Map<String, BadBinaryInfo> binaries;
+  private Map<String, BadBinaryInfo> binaries = new HashMap<>();;
 }

src/gen/java/com/uber/cadence/BadBinaries.java

@@ -7,5 +7,5 @@
 @Data
 @Accessors(chain = true)
 public class CrossClusterApplyParentClosePolicyRequestAttributes {
-  private List<ApplyParentClosePolicyRequest> children;
+  private List<ApplyParentClosePolicyRequest> children = new ArrayList<>();;
 }

src/gen/java/com/uber/cadence/CrossClusterApplyParentClosePolicyRequestAttributes.java

@@ -7,5 +7,5 @@
 @Data
 @Accessors(chain = true)
 public class CrossClusterApplyParentClosePolicyResponseAttributes {
-  private List<ApplyParentClosePolicyResult> childrenStatus;
+  private List<ApplyParentClosePolicyResult> childrenStatus = new ArrayList<>();;
 }

src/gen/java/com/uber/cadence/CrossClusterApplyParentClosePolicyResponseAttributes.java

@@ -12,5 +12,5 @@ public class CrossClusterStartChildExecutionRequestAttributes {
   private long initiatedEventID;
   private StartChildWorkflowExecutionInitiatedEventAttributes initiatedEventAttributes;
   private String targetRunID;
-  private Map<String, String> partitionConfig;
+  private Map<String, String> partitionConfig = new HashMap<>();;
 }