Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: sync User Guide to Generic Call for Streaming #1179

Merged
merged 2 commits into from
Dec 23, 2024
Merged

doc: sync User Guide to Generic Call for Streaming #1179

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52687bd
doc: upload file User Guide to Generic Call for Streaming
alice-yyds Dec 23, 2024
da7cddb
fix: title
Marina-Sakai Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 34 additions & 8 deletions content/en/docs/kitex/Tutorials/advanced-feature/generic-call/generic_streaming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
---
title: "User Guide to Generic Call for Streaming [on trial]"
title: "User Guide to Generic Call for Streaming"
date: 2024-09-19
weight: 6
keywords: ["User Guide to Generic Call for Streaming [on trial]"]
keywords: ["User Guide to Generic Call for Streaming"]
description: ""
---

## Introduction

JSON generic call for streaming interfaces is now supported (client-side only).

**However, due to the ongoing restructuring of the streaming interface to improve the user experience and to avoid making any breaking changes after release, the feature's official release is temporarily on hold. If you have a need for this feature, you can refer to the following to try it out. Please note that once it is officially released, a small adjustment may be required on your end**.

Please try the feature with kitex test branch test/grpc_json_streaming_generic by `go get github.com/cloudwego/kitex@test/grpc_json_streaming_generic`.
**JSON generic call for streaming interfaces is now supported (client-side only) from Kitex v0.12.0**.

## Usage

Expand Down Expand Up @@ -54,6 +50,10 @@ The four methods included in the example IDL correspond to four scenarios:
First of all, please initialize the streaming client. Here is an example of streaming client initialization.

```go
import (
dproto "github.com/cloudwego/dynamicgo/proto"
)

dOpts := dproto.Options{} // you can specify parsing options as you want
p, err := generic.NewPbFileProviderWithDynamicGo(your_idl, ctx, dOpts)
// create json pb generic
Expand Down Expand Up @@ -102,7 +102,7 @@ The four methods included in the example IDL correspond to four scenarios:
Here is an example of streaming client initialization.

```go
p, err := generic.generic.NewThriftFileProvider(your_idl_path)
p, err := generic.NewThriftFileProvider(your_idl_path)
/*
// if you use dynamicgo
p, err := generic.NewThriftFileProviderWithDynamicGo(idl)
Expand Down Expand Up @@ -225,3 +225,29 @@ Example:
resp, err := cli.GenericCall(ctx, "UnaryEcho", `{"message": "unary request"}`)
strResp, ok := resp.(string) // response is json string
```

## FAQ

### Recv() got err: rpc error: code = 12 desc = Method not found!

This error occurs when calling with Kitex **protobuf** generic streaming when the downstream is **gRPC-python** (gRPC libraries for other languages may also have this problem).

The root cause is that Kitex does not parse the package in the protobuf idl, so the package part of `:path` in the gPRC request is missing, and gRPC-python can't find the corresponding method.

e.g.

- normal client

`:path` - /search.gpt_engine.GPTStreamService/GPTGeneration

- protobuf generic client

`:path` - /GPTStreamService/GPTGeneration

#### Solution

Use the following branch to solve it and wait for the official release of Kitex v1.18.1 to fix this issue.

```shell
go get -u github.com/cloudwego/[email protected]
```
Loading