Improve import compatibility for sonic and jsoniter (#86)

* Improve import compatibility for sonic and jsoniter

* fix import (#87)

---------

Co-authored-by: Alex - アレックス <[email protected]>

Author: VojtechVitek

_examples/golang-basics/example.gen.go

@@ -73,6 +73,7 @@ struct Version
 
 struct ComplexType
   - meta: map<string,any>
+    + go.field.type = json.RawMessage
   - metaNestedExample: map<string,map<string,uint32>>
   - namesList: []string
   - numsList: []int64

_examples/golang-basics/example.ridl

@@ -2,6 +2,7 @@
 {{- $typeMap := .TypeMap -}}
 {{- $typePrefix := .TypePrefix -}}
 {{- $services := .Services -}}
+{{- $json := .Json -}}
 {{- $opts := .Opts }}
 
 {{- if $services -}}
@@ -155,7 +156,7 @@ func (r *streamReader) read(v interface {}) error {
 			continue
 		}
 
-		if err := json.Unmarshal(line, &v); err != nil {
+		if err := {{$json}}.Unmarshal(line, &v); err != nil {
 			return r.handleReadError(err)
 		}
 		return nil
@@ -223,7 +224,7 @@ func newRequest(ctx context.Context, url string, reqBody io.Reader, contentType
 
 // doHTTPRequest is common code to make a request to the remote service.
 func doHTTPRequest(ctx context.Context, client HTTPClient, url string, in, out interface{}) (*http.Response, error) {
-	reqBody, err := json.Marshal(in)
+	reqBody, err := {{$json}}.Marshal(in)
 	if err != nil {
 		return nil, ErrWebrpcRequestFailed.WithCausef("failed to marshal JSON body: %w", err)
 	}
@@ -248,7 +249,7 @@ func doHTTPRequest(ctx context.Context, client HTTPClient, url string, in, out i
 		}
 
 		var rpcErr WebRPCError
-		if err := json.Unmarshal(respBody, &rpcErr); err != nil {
+		if err := {{$json}}.Unmarshal(respBody, &rpcErr); err != nil {
 			return nil, ErrWebrpcBadResponse.WithCausef("failed to unmarshal server error: %w", err)
 		}
 		if rpcErr.Cause != "" {
@@ -263,7 +264,7 @@ func doHTTPRequest(ctx context.Context, client HTTPClient, url string, in, out i
 			return nil, ErrWebrpcBadResponse.WithCausef("failed to read response body: %w", err)
 		}
 
-		err = json.Unmarshal(respBody, &out)
+		err = {{$json}}.Unmarshal(respBody, &out)
 		if err != nil {
 			return nil, ErrWebrpcBadResponse.WithCausef("failed to unmarshal JSON response body: %w", err)
 		}

client.go.tmpl

@@ -70,7 +70,7 @@ import (
 {{- if eq $opts.json "stdlib" -}}
 	{{- /* Already imported in the stdlib section. */ -}}
 {{- else if eq $opts.json "jsoniter" -}}
-	{{- set $imports "github.com/json-iterator/go" "jsoniter" -}}
+	{{- set $imports "github.com/json-iterator/go" "" -}}
 {{- else if eq $opts.json "sonic" -}}
 	{{- set $imports "github.com/bytedance/sonic" "" -}}
 {{- else -}}
@@ -108,14 +108,14 @@ import (
 {{- if eq $opts.json "jsoniter" }}
 
 // Opinionated config for -json=jsoniter, see https://github.com/json-iterator/go/blob/master/config.go.
-var json = jsoniter.Config{
+var jsonCfg = jsoniter.Config{
 	ValidateJsonRawMessage: true,
 }.Froze()
 
 {{- else if eq $opts.json "sonic" }}
 
 // Opinionated config for -json=sonic, see https://github.com/bytedance/sonic/blob/main/api.go.
-var json = sonic.Config{
+var jsonCfg = sonic.Config{
 	NoNullSliceOrMap: true, // Encode empty Array or Object as '[]' or '{}' instead of 'null'.
 	CompactMarshaler: true,
 	CopyString : true,

imports.go.tmpl

@@ -157,12 +157,18 @@ func parseWebrpcGenVersions(header string) (*WebrpcGenVersions, error) {
 {{ template "types" dict "Services" .Services "Types" .Types "TypeMap" $typeMap "TypePrefix" $typePrefix "Opts" $opts }}
 {{ end -}}
 
+{{- /* Allow using custom JSON configuration. */ -}}
+{{- $json := "json" -}}
+{{- if or (eq $opts.json "jsoniter") (eq $opts.json "sonic") -}}
+  {{- $json = "jsonCfg" -}}
+{{- end -}}
+
 {{- if $opts.server }}
-{{ template "server" dict "Services" .Services "TypeMap" $typeMap "TypePrefix" $typePrefix "Opts" $opts }}
+{{ template "server" dict "Services" .Services "TypeMap" $typeMap "TypePrefix" $typePrefix "Json" $json "Opts" $opts }}
 {{ end -}}
 
 {{ if $opts.client }}
-{{ template "client" dict "Services" .Services "TypeMap" $typeMap "Opts" $opts "TypePrefix" $typePrefix }}
+{{ template "client" dict "Services" .Services "TypeMap" $typeMap "Json" $json "Opts" $opts "TypePrefix" $typePrefix }}
 {{ end -}}
 
 {{ template "helpers" dict "Opts" $opts }}

main.go.tmpl

@@ -2,6 +2,7 @@
 {{- $services := .Services -}}
 {{- $typeMap := .TypeMap -}}
 {{- $typePrefix := .TypePrefix -}}
+{{- $json := .Json -}}
 {{- $opts := .Opts -}}
 
 {{- if $services -}}
@@ -109,7 +110,7 @@ func (s *{{$serviceName}}) serve{{firstLetterToUpper $method.Name}}JSON(ctx cont
 		Arg{{$i}} {{template "field" dict "Name" $input.Name "Type" $input.Type "Optional" $input.Optional "TypeMap" $typeMap "TypePrefix" $typePrefix "TypeMeta" $input.Meta "JsonTags" true}}
 	{{- end}}
 	}{}
-	if err := json.Unmarshal(reqBody, &reqPayload); err != nil {
+	if err := {{$json}}.Unmarshal(reqBody, &reqPayload); err != nil {
 		s.sendErrorJSON(w, r, ErrWebrpcBadRequest.WithCausef("failed to unmarshal request data: %w", err))
 		return
 	}
@@ -138,9 +139,9 @@ func (s *{{$serviceName}}) serve{{firstLetterToUpper $method.Name}}JSON(ctx cont
 
 	{{- if $method.Outputs | len}}
 	{{ if $opts.fixEmptyArrays -}}
-	respBody, err := json.Marshal(initializeNilSlices(respPayload))
+	respBody, err := {{$json}}.Marshal(initializeNilSlices(respPayload))
 	{{ else -}}
-	respBody, err := json.Marshal(respPayload)
+	respBody, err := {{$json}}.Marshal(respPayload)
 	{{ end -}}
 	if err != nil {
 		s.sendErrorJSON(w, r, ErrWebrpcBadResponse.WithCausef("failed to marshal json response: %w", err))
@@ -174,7 +175,7 @@ func (s *{{$serviceName}}) serve{{firstLetterToUpper $method.Name}}JSONStream(ct
 		Arg{{$i}} {{template "field" dict "Name" $input.Name "Type" $input.Type "Optional" $input.Optional "TypeMap" $typeMap "TypePrefix" $typePrefix "TypeMeta" $input.Meta "JsonTags" true}}
 	{{- end}}
 	}{}
-	if err := json.Unmarshal(reqBody, &reqPayload); err != nil {
+	if err := {{$json}}.Unmarshal(reqBody, &reqPayload); err != nil {
 		s.sendErrorJSON(w, r, ErrWebrpcBadRequest.WithCausef("failed to unmarshal request data: %w", err))
 		return
 	}
@@ -192,7 +193,7 @@ func (s *{{$serviceName}}) serve{{firstLetterToUpper $method.Name}}JSONStream(ct
 	w.Header().Set("X-Content-Type-Options", "nosniff")
 	w.WriteHeader(http.StatusOK)
 
-	streamWriter := &{{firstLetterToLower $method.Name}}StreamWriter{streamWriter{w: w, f: f, e: json.NewEncoder(w), sendError: s.sendErrorJSON}}
+	streamWriter := &{{firstLetterToLower $method.Name}}StreamWriter{streamWriter{w: w, f: f, e: {{$json}}.NewEncoder(w), sendError: s.sendErrorJSON}}
 	if err := streamWriter.ping(); err != nil {
 		s.sendErrorJSON(w, r, ErrWebrpcStreamLost.WithCausef("failed to establish SSE stream: %w", err))
 		return
@@ -226,15 +227,15 @@ func (s *{{$serviceName}}) sendErrorJSON(w http.ResponseWriter, r *http.Request,
 		out := struct {
 			WebRPCError WebRPCError `json:"webrpcError"`
 		}{ WebRPCError: rpcErr }
-		json.NewEncoder(w).Encode(out)
+		{{$json}}.NewEncoder(w).Encode(out)
 		return	
 	}
 	{{- end }}
 
 	w.Header().Set("Content-Type", "application/json")
 	w.WriteHeader(rpcErr.HTTPStatus)
 
-	respBody, _ := json.Marshal(rpcErr)
+	respBody, _ := {{$json}}.Marshal(rpcErr)
 	w.Write(respBody)
 }
 {{- end}}
@@ -248,7 +249,7 @@ func RespondWithError(w http.ResponseWriter, err error) {
 	w.Header().Set("Content-Type", "application/json")
 	w.WriteHeader(rpcErr.HTTPStatus)
 
-	respBody, _ := json.Marshal(rpcErr)
+	respBody, _ := {{$json}}.Marshal(rpcErr)
 	w.Write(respBody)
 }