Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .spec-version
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
spec: openapi-v236.2.0
generator: chat v236.1.0-13-gc76ef78629
spec: openapi-v237.1.3
generator: chat v237.1.3-14-g6e42baa6da
43 changes: 43 additions & 0 deletions MIGRATION_v5_to_v6.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Migrating from v5 to v6

v6 changes the module path and six generated types. There are no removed endpoints, types or fields.

## Module path

```bash
go get github.com/GetStream/getstream-go/v6
```

Update every import:

```go
- import "github.com/GetStream/getstream-go/v5"
+ import "github.com/GetStream/getstream-go/v6"
```

## `ChannelMemberRequest.UserID` is now optional

`UserID` changed from `string` to `*string`. Use the `PtrTo` helper:

```go
- members := []ChannelMemberRequest{{UserID: userID}}
+ members := []ChannelMemberRequest{{UserID: PtrTo(userID)}}
```

## `ChannelMemberRequest.User` takes a request type

The field changed from `*UserResponse` to `*MemberUserRequest`, a new type carrying only the fields a request may set. If you were passing a `UserResponse` you received from the API, build a `MemberUserRequest` instead and set the fields you mean to change.

```go
- ChannelMemberRequest{User: &UserResponse{ID: id, Name: PtrTo("Alice")}}
+ ChannelMemberRequest{User: &MemberUserRequest{ID: id, Name: PtrTo("Alice")}}
```

## Reminder events carry a value, not a pointer

`Reminder` changed from `*ReminderResponseData` to `ReminderResponseData` on `ReminderCreatedEvent`, `ReminderUpdatedEvent`, `ReminderDeletedEvent` and `ReminderNotificationEvent`. Drop the nil check and the dereference:

```go
- if event.Reminder != nil { use(*event.Reminder) }
+ use(event.Reminder)
```
26 changes: 13 additions & 13 deletions chat_channel_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"testing"
"time"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -50,8 +50,8 @@ func TestChatChannelIntegration(t *testing.T) {

t.Run("CreateDistinctChannel", func(t *testing.T) {
members := []ChannelMemberRequest{
{UserID: creatorID},
{UserID: memberID1},
{UserID: PtrTo(creatorID)},
{UserID: PtrTo(memberID1)},
}

resp, err := client.Chat().GetOrCreateDistinctChannel(ctx, "messaging", &GetOrCreateDistinctChannelRequest{
Expand Down Expand Up @@ -208,8 +208,8 @@ func TestChatChannelIntegration(t *testing.T) {
// Add members
_, err := ch.Update(ctx, &UpdateChannelRequest{
AddMembers: []ChannelMemberRequest{
{UserID: memberID2},
{UserID: memberID3},
{UserID: PtrTo(memberID2)},
{UserID: PtrTo(memberID3)},
},
})
require.NoError(t, err)
Expand Down Expand Up @@ -260,11 +260,11 @@ func TestChatChannelIntegration(t *testing.T) {
Data: &ChannelInput{
CreatedByID: PtrTo(creatorID),
Members: []ChannelMemberRequest{
{UserID: creatorID},
{UserID: PtrTo(creatorID)},
},
Invites: []ChannelMemberRequest{
{UserID: memberID1},
{UserID: memberID2},
{UserID: PtrTo(memberID1)},
{UserID: PtrTo(memberID2)},
},
},
})
Expand Down Expand Up @@ -461,7 +461,7 @@ func TestChatChannelIntegration(t *testing.T) {
// Assign channel_moderator role to memberID1
_, err := ch.Update(ctx, &UpdateChannelRequest{
AssignRoles: []ChannelMemberRequest{
{UserID: memberID1, ChannelRole: PtrTo("channel_moderator")},
{UserID: PtrTo(memberID1), ChannelRole: PtrTo("channel_moderator")},
},
})
require.NoError(t, err)
Expand Down Expand Up @@ -669,8 +669,8 @@ func TestChatChannelIntegration(t *testing.T) {
// Add members with specific channel roles
_, err := ch.Update(ctx, &UpdateChannelRequest{
AddMembers: []ChannelMemberRequest{
{UserID: modUserID, ChannelRole: PtrTo("channel_moderator")},
{UserID: memberUserID2, ChannelRole: PtrTo("channel_member")},
{UserID: PtrTo(modUserID), ChannelRole: PtrTo("channel_moderator")},
{UserID: PtrTo(memberUserID2), ChannelRole: PtrTo("channel_member")},
},
})
require.NoError(t, err)
Expand Down Expand Up @@ -812,8 +812,8 @@ func TestChatChannelIntegration(t *testing.T) {
Data: &ChannelInput{
CreatedByID: PtrTo(creatorID),
Members: []ChannelMemberRequest{
{UserID: creatorID},
{UserID: memberID1},
{UserID: PtrTo(creatorID)},
{UserID: PtrTo(memberID1)},
},
},
})
Expand Down
6 changes: 3 additions & 3 deletions chat_message_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"testing"
"time"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -627,8 +627,8 @@ func TestChatMessageIntegration(t *testing.T) {
Data: &ChannelInput{
CreatedByID: PtrTo(memberUserID),
Members: []ChannelMemberRequest{
{UserID: memberUserID, ChannelRole: PtrTo("channel_member")},
{UserID: customRoleUserID, ChannelRole: PtrTo("channel_moderator")},
{UserID: PtrTo(memberUserID), ChannelRole: PtrTo("channel_member")},
{UserID: PtrTo(customRoleUserID), ChannelRole: PtrTo("channel_moderator")},
},
},
})
Expand Down
2 changes: 1 addition & 1 deletion chat_misc_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"testing"
"time"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion chat_polls_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"strings"
"testing"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion chat_reaction_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"context"
"testing"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion chat_retention_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"strings"
"testing"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion chat_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions chat_test_helpers_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"testing"
"time"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -192,7 +192,7 @@ func createTestChannelWithMembers(t *testing.T, client *Stream, creatorID string

members := make([]ChannelMemberRequest, len(memberIDs))
for i, id := range memberIDs {
members[i] = ChannelMemberRequest{UserID: id}
members[i] = ChannelMemberRequest{UserID: PtrTo(id)}
}

_, err := ch.GetOrCreate(ctx, &GetOrCreateChannelRequest{
Expand Down
2 changes: 1 addition & 1 deletion chat_user_group_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"strings"
"testing"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
Expand Down
2 changes: 1 addition & 1 deletion chat_user_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"context"
"testing"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
Expand Down
2 changes: 1 addition & 1 deletion chat_webhook_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"encoding/hex"
"testing"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
"testing"
"time"

. "github.com/GetStream/getstream-go/v5"
. "github.com/GetStream/getstream-go/v6"
"github.com/joho/godotenv"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
Expand Down
2 changes: 1 addition & 1 deletion common_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions docs/migration-from-stream-chat-go/01-setup-and-auth.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Setup and Authentication

This guide shows how to migrate setup and authentication code from `github.com/GetStream/stream-chat-go/v8` to `github.com/GetStream/getstream-go/v5`.
This guide shows how to migrate setup and authentication code from `github.com/GetStream/stream-chat-go/v8` to `github.com/GetStream/getstream-go/v6`.

## Installation

Expand All @@ -13,11 +13,11 @@ go get github.com/GetStream/stream-chat-go/v8
**After (getstream-go):**

```bash
go get github.com/GetStream/getstream-go/v5
go get github.com/GetStream/getstream-go/v6
```

**Key changes:**
- Module path changed from `stream-chat-go/v8` to `getstream-go/v5`
- Module path changed from `stream-chat-go/v8` to `getstream-go/v6`

## Client Initialization

Expand Down Expand Up @@ -52,7 +52,7 @@ package main
import (
"time"

"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down Expand Up @@ -94,7 +94,7 @@ func main() {
package main

import (
"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down Expand Up @@ -136,7 +136,7 @@ package main
import (
"time"

"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down
14 changes: 7 additions & 7 deletions docs/migration-from-stream-chat-go/02-users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Users

This guide shows how to migrate user operations from `github.com/GetStream/stream-chat-go/v8` to `github.com/GetStream/getstream-go/v5`.
This guide shows how to migrate user operations from `github.com/GetStream/stream-chat-go/v8` to `github.com/GetStream/getstream-go/v6`.

## Upsert a Single User

Expand Down Expand Up @@ -40,7 +40,7 @@ package main
import (
"context"

"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down Expand Up @@ -103,7 +103,7 @@ package main
import (
"context"

"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down Expand Up @@ -162,7 +162,7 @@ package main
import (
"context"

"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down Expand Up @@ -225,7 +225,7 @@ package main
import (
"context"

"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down Expand Up @@ -283,7 +283,7 @@ package main
import (
"context"

"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down Expand Up @@ -331,7 +331,7 @@ package main
import (
"context"

"github.com/GetStream/getstream-go/v5"
"github.com/GetStream/getstream-go/v6"
)

func main() {
Expand Down
Loading
Loading