64 json e2e test (#131)

* Add first case for e2e json test in go

* Impl CI and automate client servers for json e2e test

* Put e2e test in it ci stage

* Fix ci go version in client test

* Fix setup go in ci

* Move e2e test to maven module to ease ci cache and run

* Remove server lifecycle management from java e2e test

* Set ci host os version

* Add json e2e test for java time

* Add json e2e for generic class

* Add json e2e for cyclic class

* Add json e2e for map classes

* Add json e2e for array class

* Add json e2e for complex record

* Add json e2e for math types

* Add typescript server

* Add value validations in typescript client server for json e2e test

* Add rust http server

* Fix rust http port

* Use enum value type for Rust struct enum field type

* Add TagLiterals annotion

* Impl rust server to handle different types for json e2e test

* Allow config tag literals for fields and methods

* Save tagLiterals in components

* Populate tagLiterals in CompositeTypeDefParser

* Emit tagLiterals for rust code

* Add JavaRecord for rust e2e test

* Map enumValue type for rust map key

* Fix JavaRecord

* Add tag literals to all applicable templates

* Set permission to ci

* Increase e2e ready check timeout

Author: cuzfrog

.github/workflows/ci.yaml

@@ -1,4 +1,7 @@
 name: CI
+permissions:
+  contents: read
+  pull-requests: write
 on:
   push:
     branches:
@@ -7,15 +10,21 @@ on:
     branches:
       - master
 
+env:
+  JAVA_VERSION: 21
+  NODE_VERSION: 22
+  GO_VERSION: 1.24
+  RUST_VERSION: 1.83.0
+
 jobs:
   style_check:
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: 21
+          java-version: ${{env.JAVA_VERSION}}
       - uses: actions/cache@v4
         with:
           path: ~/.m2/repository
@@ -30,7 +39,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: 21
+          java-version: ${{env.JAVA_VERSION}}
       - uses: actions/cache@v4
         with:
           path: ~/.m2/repository
@@ -52,8 +61,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: jars
-          path: |
-              ~/.m2/repository/online/sharedtype
+          path: ~/.m2/repository/online/sharedtype
           if-no-files-found: error
           retention-days: 3
       - name: Remove jars from cache
@@ -77,7 +85,7 @@ jobs:
           path: ~/.m2/repository/online/sharedtype
 #      - name: Display downloaded artifact
 #        run: ls -lhR ~/.m2/repository/online/sharedtype
-      - uses: actions/cache@v4
+      - uses: actions/cache/restore@v4
         with:
           path: ~/.m2/repository
           key: build_maven
@@ -91,7 +99,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 22
+          node-version: ${{env.NODE_VERSION}}
       - uses: actions/download-artifact@v4
         with:
           name: generated-sources
@@ -106,17 +114,35 @@ jobs:
 
       - uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          toolchain: 1.83.0
+          toolchain: ${{env.RUST_VERSION}}
       - name: Test Rust
         working-directory: client-test/rust
         run: cargo test
 
       - uses: actions/setup-go@v5
         with:
-          go-version: 1.24
+          cache-dependency-path: client-test/go/go.sum
+          go-version-file: client-test/go/go.mod
       - name: Test Golang
         working-directory: client-test/go
-        run: go get && go test
+        run: go get && go test ./...
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: ${{env.JAVA_VERSION}}
+      - uses: actions/cache/restore@v4
+        with:
+          path: ~/.m2/repository
+          key: build_maven
+      - uses: actions/download-artifact@v4
+        with:
+          name: jars
+          path: ~/.m2/repository/online/sharedtype
+      - name: E2E Test
+        run: |
+          misc/start-client-servers.sh &
+          ./mvnw verify -Pe2e -e --ntp -B
 
 #  clean-artifact:
 #    needs: [ jdk_compatibility_test, client_test ]

annotation/src/main/java/online/sharedtype/SharedType.java

@@ -2,6 +2,7 @@
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
@@ -242,9 +243,11 @@
      * Whether to mark generated type fields as readonly. Default fallback to global properties.
      *
      * @return value can be one of:
-     * "all" - all fields are readonly
-     * "acyclic" - only fields of not cyclic-referenced types are readonly
-     * "none" - no fields are readonly
+     * <ul>
+     *     <li>"all" - all fields are readonly</li>
+     *     <li>"acyclic" - only fields of not cyclic-referenced types are readonly</li>
+     *     <li>"none" - no fields are readonly</li>
+     * </ul>
      */
     String typescriptFieldReadonlyType() default "";
 
@@ -301,7 +304,6 @@
      * The enum value must be "compile-time resolvable" in enum constant expressions (See "Constant" section in {@link SharedType}).
      * Note: When there are multiple enum constant constructor parameters, the value is resolved by field order.
      * If the constructor parameter order is different from the field order, value will not be resolved correctly.
-     * Additional custom annotation types can be configured via global properties.
      * <pre>
      * {@code
      * //A simple example:
@@ -315,13 +317,32 @@
      * type Enum = 1 | 2;
      * }
      * </pre>
-     * <br>
+     * Additional custom annotation types can be configured via global properties. E.g. {@code @JsonValue} in Jackson.
      */
     @Target({ElementType.FIELD})
     @Retention(RetentionPolicy.CLASS)
     @interface EnumValue {
     }
 
+    /**
+     * Add any tag literals to a field. E.g.
+     * <pre>
+     *     {@code
+     *     @SharedType.TagLiterals(tags = "#[serde(skip)]", targets = RUST)
+     *     private final Object ignoredField;
+     *     }
+     * </pre>
+     * It's treated as plain string, thus can also be used to emit comments or documentation.
+     */
+    @Target({ElementType.FIELD, ElementType.METHOD})
+    @Retention(RetentionPolicy.SOURCE)
+    @Repeatable(TagLiterals.class)
+    @interface TagLiteral {
+        String[] tags();
+        /** If empty, fallback to globally enabled targets. */
+        TargetType[] targets() default {};
+    }
+
     enum ComponentType {
         /**
          * Represents:
@@ -360,4 +381,8 @@ enum OptionalBool {
          */
         DEFAULT,
     }
+
+    enum TargetType {
+        TYPESCRIPT, GO, RUST
+    }
 }

annotation/src/main/java/online/sharedtype/TagLiterals.java

@@ -0,0 +1,12 @@
+package online.sharedtype;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.FIELD})
+@Retention(RetentionPolicy.SOURCE)
+public @interface TagLiterals {
+    SharedType.TagLiteral[] value();
+}

client-test/go/go.mod

@@ -2,9 +2,13 @@ module sharedtype.online/go-client-test
 
 go 1.23.2
 
+require (
+	github.com/go-chi/chi/v5 v5.2.1
+	github.com/stretchr/testify v1.10.0
+)
+
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/stretchr/testify v1.10.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

client-test/go/go.sum

@@ -1,9 +1,12 @@
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-chi/chi/v5 v5.2.1 h1:KOIHODQj58PmL80G2Eak4WdvUzjSJSm0vG72crDCqb8=
+github.com/go-chi/chi/v5 v5.2.1/go.mod h1:L2yAIGWB3H+phAw1NxKwWM+7eUH/lU8pOMm5hHcoops=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

client-test/go/main_test.go

@@ -0,0 +1,70 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"log/slog"
+	"net/http"
+
+	"github.com/go-chi/chi/v5"
+	"github.com/go-chi/chi/v5/middleware"
+	"sharedtype.online/go-client-test/sharedtype"
+)
+
+func main() {
+	r := chi.NewRouter()
+	r.Use(middleware.Logger)
+	r.Get("/health", func(w http.ResponseWriter, r *http.Request) {
+		w.Write([]byte(`ok`))
+	})
+	r.Post("/{typeName}", route)
+	fmt.Println("Server started on :3001, waiting for requests...")
+	http.ListenAndServe(":3001", r)
+	defer fmt.Println("Server stopped.")
+}
+
+func route(w http.ResponseWriter, r *http.Request) {
+	typeName := chi.URLParam(r, "typeName")
+	res := createStruct(typeName)
+
+	if res == nil {
+		http.Error(w, fmt.Sprintf("Unknown typeName: %s", typeName), 400)
+		return
+	}
+
+	if err := json.NewDecoder(r.Body).Decode(res); err != nil {
+		http.Error(w, err.Error(), 400)
+		slog.Error("Failed to decode request body", "error", err)
+		return
+	}
+
+	w.Header().Set("Content-Type", "application/json")
+
+	if err := json.NewEncoder(w).Encode(res); err != nil {
+		http.Error(w, err.Error(), 500)
+		return
+	}
+}
+
+func createStruct(typename string) any {
+	switch typename {
+	case "JavaClass":
+		return &sharedtype.JavaClass{}
+	case "JavaTimeClass":
+		return &sharedtype.JavaTimeClass{}
+	case "SubtypeWithNestedCustomTypeString":
+		return &sharedtype.SubtypeWithNestedCustomTypeString{}
+	case "DependencyClassA":
+		return &sharedtype.DependencyClassA{}
+	case "MapClass":
+		return &sharedtype.MapClass{}
+	case "ArrayClass":
+		return &sharedtype.ArrayClass{}
+	case "JavaRecord":
+		return &sharedtype.JavaRecord[string]{}
+	case "MathClass":
+		return &sharedtype.MathClass{}
+	default:
+		return nil
+	}
+}

client-test/go/server.go

@@ -0,0 +1 @@
+../../../it/java17/target/generated-sources/types.go

client-test/go/sharedtype/types.go

@@ -1,5 +1,30 @@
 package sharedtype
 
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMain(t *testing.T) {
+	dependencyClassC1.A = dependencyClassA1
+
+	RecursiveClass1.DirectRef = &RecursiveClass{
+		DirectRef: nil,
+		ArrayRef:  []RecursiveClass{},
+	}
+
+	OptionalMethods1.MapNestedValueOptional = &map[int32]string{1: "foo"}
+	OptionalMethods1.SetNestedValueOptional = &[]string{"foo", "bar"}
+	OptionalMethods1.NestedValueOptional = &List1[0]
+}
+
+func TestConstants(t *testing.T) {
+	assert.Equal(t, float32(1.888), FLOAT_VALUE)
+	assert.Equal(t, "MilkyWay", REFERENCED_ENUM_VALUE)
+	assert.Equal(t, int32(1), MyEnumConstants.INT_VALUE)
+}
+
 var List1 = []EnumGalaxy{"Andromeda", "MilkyWay", "Triangulum"}
 var Record1 = map[EnumTShirt]int32{
 	S: 1,
@@ -27,7 +52,7 @@ var dependencyClassA1 = &DependencyClassA{
 var Obj = JavaRecord[string]{
 	BoxedBoolean:                  false,
 	BoxedByte:                     0,
-	BoxedChar:                     'a',
+	BoxedChar:                     "a",
 	BoxedDouble:                   0,
 	BoxedFloat:                    0,
 	BoxedInt:                      0,
@@ -47,7 +72,7 @@ var Obj = JavaRecord[string]{
 	Object:                        nil,
 	PrimitiveBoolean:              false,
 	PrimitiveByte:                 0,
-	PrimitiveChar:                 'b',
+	PrimitiveChar:                 "b",
 	PrimitiveDouble:               0,
 	PrimitiveFloat:                0,
 	PrimitiveInt:                  0,