The Event structure is missing some of the fields that are being passed for webhook event such as members at root level. The structure needs to be updated to match with current fields that are being passed for webhook event.

it should be filled.

See the context and the reason at #5 (comment)

If you first grab a user record like so:

filter := map[string]interface{}{
    "id": "<user id>",
}
users, usersErr := streamClient.QueryUsers(&stream.QueryOption{
    Filter: filter,
    Limit:  1,
})

Then modify the user and attempt to save it, like ..

streamUser.Image = "<photo url>"
_, streamUpdateErr := streamClient.UpdateUser(streamUser)

It will fail with the following error:

chat-client: HTTP POST https://chat-us-east-1.stream-io-api.com/users?api_key=<secret> status 400 Bad Request: {\"code\":4,\"message\":\"UpdateUsers failed with error: \\\"users[<userid>].online is a reserved field\\\"\",\"exception_fields\":{\"users[<userid>].online\":\"users[<userid>].online is a reserved field\"}

It seems like if that is reserved, it should be omitted?

Docs show that there should be a data_template field, but there isn't one

Tokens created using CreateToken are showing as malformed or as having an invalid Secret. The error is present when using both the CLI and the client SDKs.

Error message example (from CLI):

Error: Malformed JWT token or Stream API secret.

also might want to generate a message such as PRs merged from the previous release.

Getting the error unexpected EOF when making successive calls.

I believe the open connection is being reused and is unexpectedly being closed by stream.
We probably want to set the Close boolean to true when creating the request.
https://cs.opensource.google/go/go/+/refs/tags/go1.18:src/net/http/request.go;l=208-218

to provide more context to the users.

pkg/errors could be leveraged.

The Go SDK QueryResponse type does not include watchers which is returned from the API. This currently prevents the ability to query a channel's watchers.

If I clone this repository and run the tests, I see several test failures. I took a look at ci.yml and I don't see a reason why these would fail unless:

• My trial account has some difference with the key/secret vs. what's used in CI?
• Something has changed, since CI hasn't ran these tests in a few months?

❯ STREAM_KEY={my api key} STREAM_SECRET={my secret} go test
--- FAIL: TestClient_UpdateAppSettings (0.25s)
    app_test.go:27: 
        	Error Trace:	app_test.go:27
        	Error:      	Received unexpected error:
        	            	UpdateApp failed with error: "production app can not have disable_auth_checks flag enabled"
        	Test:       	TestClient_UpdateAppSettings
--- FAIL: TestClient_DeleteUsers (12.00s)
    async_tasks_test.go:81: 
        	Error Trace:	async_tasks_test.go:81
        	Error:      	Should be true
        	Test:       	TestClient_DeleteUsers
        	Messages:   	task did not succeed

--- FAIL: TestClient_Devices (0.42s)
    device_test.go:23: 
        	Error Trace:	device_test.go:23
        	Error:      	Received unexpected error:
        	            	CreateDevice failed with error: "push provider "" with type "firebase" not found"
        	Test:       	TestClient_Devices
        	Messages:   	add device
--- FAIL: TestClient_SendMessage_Pending (1.01s)
    message_test.go:39: 
        	Error Trace:	message_test.go:39
        	Error:      	Received unexpected error:
        	            	SendMessage failed with error: "pending messages not enabled for this app"
        	Test:       	TestClient_SendMessage_Pending
FAIL
exit status 1
FAIL	github.com/GetStream/stream-chat-go/v6	130.451s

Seems like I am getting an error if I try to get a deleted message.

We are seeing errors when trying to create new users with a username that is already present in the team. This is expected behaviour. However, if the library could expose custom errors we could check with errors.As() that the error is a ErrDuplicateUsername and try adding a 1 suffix (and 2, 3... until the http response is 200).
https://getstream.io/chat/docs/react/api_errors_response/

I'm getting an API error when attempting to mute or unmute a channel that's been initialized without querying it:

streamClient.Channel("messaging", channelID).Mute(userID, nil)

which results in the following API error:

{
  "code": 4,
  "message": "MuteChannel failed with error: \"channel_cid 'MuteChannelRequest.channel_cid' Error:Field validation for 'channel_cid' failed on the 'required_without' tag, channel_cids 'MuteChannelRequest.channel_cids' Error:Field validation for 'channel_cids' failed on the 'required_without' tag\"",
  "exception_fields": {
    "channel_cid": "channel_cid 'MuteChannelRequest.channel_cid' Error:Field validation for 'channel_cid' failed on the 'required_without' tag",
    "channel_cids": "channel_cids 'MuteChannelRequest.channel_cids' Error:Field validation for 'channel_cids' failed on the 'required_without' tag"
  },
  "StatusCode": 400,
  "duration": "0.00ms",
  "more_info": "https://getstream.io/chat/docs/api_errors_response"
}

It appears that this is because the channel's CID is only initialized when coming from an API response, not when using the client's Channel() function to initialize one without querying for it:

Obviously this is easy to fix on our side (can just set CID manually), and should be an easy-ish fix to initalize CID in func (c *Client) Channel(...), but wanted to report it first since it looks like these two mute/unmute methods may be the only ones using the CID internally—thought maybe there was a reason (deprecation?).

gz#9275

It seems that sending a message is removing user attributes such as avatar URL. According to the message docs:

Note: calling the Send Message endpoint using server-side auth (i.e setting the user in the message object) will also trigger a user update. Please make sure to include all necessary user fields in order not to lose any information.

Currently this client doesn't seem to do this or allow it: https://github.com/GetStream/stream-chat-go/blob/v3.0.0/message.go#L191.

Anyway, I'd rather not have to send the entire user object each time. Would there be a way for the API to support simply sending the UserID so a user update isn't triggered on every message?

gz#6673

Using the following code:

body, bodyErr := ioutil.ReadAll(request.Body)
if bodyErr != nil {
  ...
}
isValid := streamClient.VerifyWebhook(body, []byte(signature))

The value for isValid will always be false.

I noticed that the hmac used to validate is len 32 and the signature is len 64. Not sure if that's the issue. It's possible i'm also just doing it wrong.

I started writing this code to do a support task for someone yesterday. It wasn't working so I eventually gave up and rewrote it in python in order to try and move forward with the support ticket.

I saved the code because it seems like a bug we need to solve (and there might be a couple here).

To replicate the issue:

1. run the program with the -populate flag
2. run the program without the `-populate flag

First issue:

2020/04/29 11:21:33 Query Channels iteration: 0
2020/04/29 11:21:33 Querying with: &stream_chat.QueryOption{Filter:map[string]interface {}{"type":main.obj{"$in":[]string{"messaging", "livestream"}}}, Limit:20, Offset:0}
2020/04/29 11:21:33 Unsolicited response received on idle HTTP channel starting with "HTTP/1.1 400 Bad Request\r\nDate: Wed, 29 Apr 2020 09:21:33 GMT\r\nContent-Type: text/plain; charset=utf-8\r\nContent-Length: 20\r\nConnection: close\r\n\r\nInvalid HTTP request"; err=<nil>
Got 0 channels

This is related to #74 and may also be related to #56

Code

package main

import (
	"flag"
	"fmt"
	"log"
	"os"

	chat "github.com/GetStream/stream-chat-go"
	"github.com/google/uuid"
)

type config struct {
	apiKey    string
	apiSecret string
	populate  bool

	doIt bool
}

func main() {
	conf := config{}
	flag.StringVar(&conf.apiKey, "key", "", "API Key to use to connect")
	flag.StringVar(&conf.apiSecret, "secret", "", "API Secret to use to connect")
	flag.BoolVar(&conf.populate, "populate", false, "populate channels")
	flag.Parse()

	client, err := chat.NewClient(conf.apiKey, []byte(conf.apiSecret))
	if err != nil {
		log.Fatalf("Error creating client: %v", err)
	}

	if conf.populate {
		if err := populate(client); err != nil {
			log.Fatalf("error populating: %#v", err)
		}
		os.Exit(0)
	}

	channels, err := queryChannels(client)
	if err != nil {
		log.Fatalf("Error querying channels: %v", err)
	}
	fmt.Printf("Got %d channels\n", len(channels))
	for _, c := range channels {
		log.Printf("Channel: %s", c.CID)
	}
}

func populate(client *chat.Client) error {
	for i := 0; i < 1000; i++ {
		if _, err := client.CreateChannel("messaging", uuid.New().String(), "tabs", nil); err != nil {
			return err
		}
	}
	return nil
}

type obj map[string]interface{}

func queryChannels(client *chat.Client) ([]*chat.Channel, error) {
	results := []*chat.Channel{}

	limit := 20
	lastID := ""

	opts := &chat.QueryOption{
		Limit: limit,
		Filter: obj{
			"type": obj{
				"$in": []string{
					"messaging",
					"livestream",
				},
			},
		},
	}

	for i := 0; i < 1000; i++ {
		log.Printf("Query Channels iteration: %d", i)
		if lastID != "" {
			log.Printf("Setting lastID of %q", lastID)
			opts.Filter["id_gt"] = lastID
		}

		log.Printf("Querying with: %#v", opts)
		res, err := client.QueryChannels(opts, &chat.SortOption{Field: "id", Direction: 1})
		if err != nil {
			return nil, err
		}
		if len(res) == 0 {
			break
		}
		lastID = res[len(res)-1].CID
		results = append(results, res...)
	}

	return results, nil
}

I used the library to add my SQS config on my app.
But I couldn't remove it. If I try to set it as empty string it still doesn't work.

Can you add a way to do it?

they are same but duplicated & diverged

This issue was originally reported on stream-go2

There I found a suggestion to add a "client" timeout

Is there a similar way to address the issue in the stream-chat-go library ?

go: 1.13.6
os: windows

Windows treats GetStream and getstream as the same thing. When vendoring the library on windows and deploying to linux-based systems (i.e. via a Google Cloud function), the vendoring process will use github.com/GetStream for all packages.

However, there is a dependency on github.com/getstream/easyjson (which uses the lowercase convention) and the build tools will fail to find the vendored dependency when interacting with case-sensitive file systems / OSes.

It would be great if the package names were consistent to avoid this issue.

stream-go-client should be stream-go-client-major.minor.patch

Stream docs Go example uses function ch.query which is not exposed. So the example does not work.

options := map[string]interface{}{ 
	"messages": map[string]interface{}{"limit": 50, "id_lt": lastMessageId}, 
	"members":  map[string]interface{}{"limit": 10, "offset": 0}, 
	"watchers": map[string]interface{}{"limit": 20, "offset": 0}, 
} 
 
ch.query(ctx, options, nil)

Changing the function to exposed ch.Query doesn't work either since that function does not allow passing options to it.

Thus I found no way to query channel messages with pagination using the Go client.

The github README for this project refers to methods that are not showing up such as CreateChannelWithMembers, i'm guessing these were removed but the docs havent been updated?

This is the error I get when I try to run the command specified in the README.

Do we have any way to easily check a if a token is expired server-side ?

gz#7047

Expected Behavior:
I should be able to construct a Go client instance with an http.Client where http.RoundTripper is *otelhttp.Transport

Actual Behavior:
NewClient panics

getting below error on creating clent"-

panic: interface conversion: http.RoundTripper is *otelhttp.Transport, not *http.Transport
goroutine 1 [running]:
github.com/GetStream/stream-chat-go/v6.NewClient({0x13fa848, 0xc}, {0x1430def, 0x40}, {0x0, 0x0, 0x8?})
/home/Rahul/go/pkg/mod/github.com/!get!stream/stream-chat-go/[email protected]/client.go:80 +0x3ea

under https://github.com/GetStream/stream-chat-go/blob/v6.5.0/channel.go#L373

go can accept nil as the parameter for options

but because L373 is coded as

	for _, fn := range options {
		fn(opts)
	}

nil will cause range to panic. Maybe it's cleaner to have this as

    if options != nil {
	for _, fn := range options {
		fn(opts)
	}
    }

I recently updated to the latest version v3.12.1 (previously it seems that i was using v1.0.0, I didn't pay attention (or it was missing) to the README which shows both an import to /v3 and an installation step with /v3 at the end.
Here's my code right now -

	streamChatClient, err := streamchat.NewClient(streamKey, streamSecret)
	if err != nil {
		return nil, nil, err
	}
	streamChatClient.BaseURL = "https://chat-proxy-dublin.stream-io-api.com"
	err := streamChatClient.UpdateAppSettings(&streamchat.AppSettings{
		FirebaseConfig: &streamchat.FirebaseConfig{
			Enabled: true,
			DataTemplate: `{
    "sender": "{{ sender.id }}",
    "dm_id": "{{ channel.id }}",
    "message": "{{ message.id }}"
}`,
			NotificationTemplate: `{
	"title": "{{ sender.nickname }}",
	"body": "{{ message.text }}",
	"sound": "default"
}`,
		},
	})

but upon starting that code I get the following error -

chat-client: HTTP PATCH https://chat-proxy-dublin.stream-io-api.com/app?api_key=<snip> status 400 Bad Request: {"code":4,"message":"UpdateApp failed with error: \"server_key is not a valid\"","StatusCode":400,"duration":"0.00ms","more_info":"https://getstream.io/chat/docs/api_errors_response"}

What were some changes from v1 to v3 that could be causing this issue?

https://pkg.go.dev won't show documentation otherwise.

/cc @tbarbugli

Linked to Zendesk issue

gz#6218

These interfaces should be defined by user and adds no benefit in SDK except maintenance burden.
Additionally, there are too big.

Looks like the request to send a message doesn't include the Type field: https://github.com/GetStream/stream-chat-go/blob/v3.0.0/message.go#L76-L84

gz#6674

Per the docs, I should be able to set an x-stream-ext header to pass arbitrary info through the before send webhook's request_info payload, but I'm unable to find how to add configure that. Is this not supported in the Go SDK?

And how I can define a preferable region?

Thanks.

Hi people

According to the source code, pagination parameters for the channel querying should be passed within the filter_conditions.
In docs it is suggested to pass the query parameters on the root level of the payload JSON structure (queryChannelRequest struct in Go SDK instead of QueryOption nested struct).

References
In Go SDK:
https://github.com/GetStream/stream-chat-go/blob/master/query.go#L102

In docs:
https://getstream.io/chat/docs/query_channels/#query-options

Steps to reproduce

1. Create at least two channels
2. Call QueryChannels method without any pagination options passed
3. Make sure you receive your channels in the response
4. Call QueryChannels method with explicit pagination rules (limit: 10, offset: 1)

Expected
Channels are returned respecting the provided pagination parameters

Actual
Empty channels list is returned

I have been searching for a way to mute/unmute/Mark as Read users in the same channel in bulk.

Since, I have not found any way I have to do this in loop. This increases the time taken per request due to multiple network RTTs, although I solved this by unblocking other requests of queue using go routines but would like to know if something like this exists for getting this task done in bulk in one shot ?

If not, can I expect any update related to this ?

I just notice that in the other language the Channel ID is optional. But in this library, it's mandatory. So now I got duplicate channel, which one generated by the backend and the other one is generated by the front end.

I think this is the issue about the consistency. While other language allow it to be null, but in Go the Channel ID is mandatory.

Could you please solve this inconsistency issue?

gz#11081

Hello team,
I am getting the following error when I am trying to send the messages on the same channel through goroutines-
Post https://chat-us-east-1.stream-io-api.com/channels/team/5e5e5652eba234fa6855ecd8/message?api_key=<api_key>: readLoopPeekFailLocked:
Please let me know if some fix is needed from my side or it is not possible to send parallel requests to send messages.

• Export user
• Deactivate user
• Reactivate user
• Delete user

Will need these tests to reference for chat docs

PaginationParamsRequest is typed as string when it should be typed as int. This causes the request to fail with this error:

error: \"expected number for field \"watchers.id_gte\" but got number `0`\nexpected number for field \"watchers.id_gte.id_lte\" but got number `0`\""

The CreateToken function should accept nil as a value for token expiration. The expire value is a time.Time type and it cannot be set to nil.

Also, the documentation on the site it wrong. It shows: token := client.CreateToken("john", null) which is a copy error as null isn't valid Go code.

Passing id_gt or any other id params does not work, see the screenshot below of my Postman request returning user with id 15 even though I passed in id_gt: 100. This seems to be an issue with the REST API and no the go SDK but could not find a more appropriate place to open an issue so let me know if there is a more appropriate place to raise this issue. Thank you!

https://getstream.io/chat/docs/js/?preview=1#export_user_data

It should be parsed and returned. Same for other async operations I assume.

See the context at #38 (comment)

If decided, happy to take care it.