[CHA-647]: support shared locations (#326)

* feat(cha-769): support shared locations

* minor fixes

* refactor

* fix unit test

* fix unit tests

* fix unit test

* feat(cha-769): support shared location

* clean up

* clean up

---------

Co-authored-by: Rafael Marinho <[email protected]>

Author: rafaelmf3

app.go

@@ -53,6 +53,7 @@ type AppSettings struct {
 	ChannelHideMembersOnly    *bool                         `json:"channel_hide_members_only,omitempty"`
 	AsyncModerationConfig     *AsyncModerationConfiguration `json:"async_moderation_config,omitempty"`
 	EventHooks                []EventHook                   `json:"event_hooks,omitempty"`
+	SharedLocationsEnabled    *bool                         `json:"shared_locations_enabled,omitempty"`
 }
 
 func (a *AppSettings) SetDisableAuth(b bool) *AppSettings {
@@ -100,6 +101,11 @@ func (a *AppSettings) SetEventHooks(eventHooks []EventHook) *AppSettings {
 	return a
 }
 
+func (a *AppSettings) SetSharedLocationsEnabled(b bool) *AppSettings {
+	a.SharedLocationsEnabled = &b
+	return a
+}
+
 func NewAppSettings() *AppSettings {
 	return &AppSettings{}
 }

message.go

@@ -65,6 +65,8 @@ type Message struct {
 	DeletedAt *time.Time `json:"deleted_at,omitempty"`
 
 	ExtraData map[string]interface{} `json:"-"`
+
+	SharedLocation *SharedLocation `json:"shared_location,omitempty"`
 }
 
 type messageForJSON Message
@@ -107,6 +109,7 @@ func (m *Message) toRequest() messageRequest {
 		Silent:               m.Silent,
 		QuotedMessageID:      m.QuotedMessageID,
 		RestrictedVisibility: m.RestrictedVisibility,
+		SharedLocation:       m.SharedLocation,
 	}
 
 	if len(m.MentionedUsers) > 0 {
@@ -145,6 +148,7 @@ type messageRequestMessage struct {
 	HTML                 string                 `json:"html,omitempty"`
 	Pinned               bool                   `json:"pinned,omitempty"`
 	RestrictedVisibility []string               `json:"restricted_visibility"`
+	SharedLocation       *SharedLocation        `json:"shared_location,omitempty"`
 	ExtraData            map[string]interface{} `json:"-"`
 }
 

shared_locations.go

@@ -0,0 +1,71 @@
+package stream_chat
+
+import (
+	"context"
+	"errors"
+	"net/http"
+	"net/url"
+	"path"
+	"time"
+)
+
+type SharedLocation struct {
+	MessageID  string `json:"message_id"`
+	ChannelCID string `json:"channel_cid"`
+	UserID     string `json:"user_id"`
+
+	Latitude          *float64   `json:"latitude,omitempty"`
+	Longitude         *float64   `json:"longitude,omitempty"`
+	CreatedByDeviceID string     `json:"created_by_device_id"`
+	EndAt             *time.Time `json:"end_at,omitempty"`
+
+	CreatedAt time.Time `json:"created_at"`
+	UpdatedAt time.Time `json:"updated_at"`
+}
+
+type ActiveLiveLocationsResponse struct {
+	ActiveLiveLocations []*SharedLocation `json:"active_live_locations"`
+	Response
+}
+
+type SharedLocationResponse struct {
+	SharedLocation
+
+	Message *MessageResponse `json:"message,omitempty"`
+	Channel *Channel         `json:"channel,omitempty"`
+}
+
+// GetUserActiveLocations returns all active live locations for a user
+func (c *Client) GetUserActiveLocations(ctx context.Context, userID string) (*ActiveLiveLocationsResponse, error) {
+	path := path.Join("users", "live_locations")
+	var resp ActiveLiveLocationsResponse
+	if userID == "" {
+		return nil, errors.New("user ID is empty")
+	}
+
+	if userID == "" {
+		return nil, errors.New("user ID is empty")
+	}
+
+	params := url.Values{}
+	params.Set("user_id", userID)
+
+	err := c.makeRequest(ctx, http.MethodGet, path, params, nil, &resp)
+	return &resp, err
+}
+
+// UpdateUserActiveLocation updates a location
+func (c *Client) UpdateUserActiveLocation(ctx context.Context, userID string, location *SharedLocation) (*SharedLocationResponse, error) {
+	path := path.Join("users", "live_locations")
+	var resp SharedLocationResponse
+
+	if userID == "" {
+		return nil, errors.New("user ID is empty")
+	}
+
+	params := url.Values{}
+	params.Set("user_id", userID)
+
+	err := c.makeRequest(ctx, http.MethodPut, path, params, location, &resp)
+	return &resp, err
+}

shared_locations_test.go

@@ -0,0 +1,113 @@
+package stream_chat
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func createTestChannelWithSharedLocations(t *testing.T, c *Client) (*Channel, *User) {
+	t.Helper()
+
+	ctx := context.Background()
+	userID := "test-user-" + randomString(10)
+	channelID := "test-channel-" + randomString(10)
+
+	user := &User{ID: userID}
+	resp, err := c.UpsertUser(ctx, user)
+	require.NoError(t, err)
+	user = resp.User
+
+	channelResp, err := c.CreateChannelWithMembers(ctx, "messaging", channelID, userID)
+	require.NoError(t, err)
+
+	_, err = channelResp.Channel.PartialUpdate(ctx, PartialUpdate{
+		Set: map[string]interface{}{
+			"config_overrides": map[string]interface{}{
+				"shared_locations": true,
+			},
+		},
+	})
+	require.NoError(t, err)
+
+	t.Cleanup(func() {
+		_, _ = c.DeleteUsers(ctx, []string{userID}, DeleteUserOptions{
+			User:          HardDelete,
+			Messages:      HardDelete,
+			Conversations: HardDelete,
+		})
+		_, _ = c.DeleteChannels(ctx, []string{channelResp.Channel.CID}, true)
+	})
+
+	return channelResp.Channel, user
+}
+
+func TestClient_LiveLocation(t *testing.T) {
+	c := initClient(t)
+	ctx := context.Background()
+
+	settings := NewAppSettings().SetSharedLocationsEnabled(true)
+
+	_, err := c.UpdateAppSettings(ctx, settings)
+	require.NoError(t, err)
+
+	// Create a user
+	channel, user := createTestChannelWithSharedLocations(t, c)
+
+	longitude := -122.4194
+	latitude := 38.999
+
+	// Create a shared location
+	location := &SharedLocation{
+		Longitude:         &longitude,
+		Latitude:          &latitude,
+		EndAt:             timePtr(time.Now().Add(1 * time.Hour)),
+		CreatedByDeviceID: "test-device",
+	}
+
+	messageResp, err := channel.SendMessage(ctx, &Message{
+		SharedLocation: location,
+		Text:           "Test message for shared location",
+	}, user.ID)
+	require.NoError(t, err)
+	message := messageResp.Message
+
+	longitude = -122.4194
+	latitude = 38.999
+
+	newLocation := &SharedLocation{
+		MessageID:         message.ID,
+		Longitude:         &longitude,
+		Latitude:          &latitude,
+		EndAt:             timePtr(time.Now().Add(10 * time.Hour)),
+		CreatedByDeviceID: "test-device",
+	}
+
+	// Update the location
+	updateResp1, err := c.UpdateUserActiveLocation(ctx, user.ID, newLocation)
+	require.NoError(t, err, "UpdateUserActiveLocation should not return an error")
+	require.NotNil(t, updateResp1)
+	assert.Equal(t, newLocation.Latitude, updateResp1.Latitude)
+	assert.Equal(t, newLocation.Longitude, updateResp1.Longitude)
+
+	// Get active live locations
+	getResp, err := c.GetUserActiveLocations(ctx, user.ID)
+	require.NoError(t, err, "GetUserActiveLocations should not return an error")
+	require.NotNil(t, getResp)
+	require.NotEmpty(t, getResp.ActiveLiveLocations, "Should have active live locations")
+
+	// Verify the location data
+	found := false
+	for _, loc := range getResp.ActiveLiveLocations {
+		if loc.MessageID == messageResp.Message.ID {
+			found = true
+			assert.Equal(t, messageResp.Message.SharedLocation.Latitude, loc.Latitude)
+			assert.Equal(t, messageResp.Message.SharedLocation.Longitude, loc.Longitude)
+			break
+		}
+	}
+	assert.True(t, found, "Should find the updated location")
+}

user_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"log"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -452,6 +453,12 @@ func TestClient_RestoreUsers(t *testing.T) {
 		}
 	})
 }
+
+// Helper function to create a time pointer
+func timePtr(t time.Time) *time.Time {
+	return &t
+}
+
 func ExampleClient_UpsertUser() {
 	client, _ := NewClient("XXXX", "XXXX")
 	ctx := context.Background()