Merge pull request #401 from rusq/canvas

Add support for channel canvases

internal/chunk/dirproc/conversations.go

@@ -8,6 +8,7 @@ import (
 	"runtime/trace"
 
 	"github.com/rusq/slack"
+
 	"github.com/rusq/slackdump/v3/internal/chunk"
 	"github.com/rusq/slackdump/v3/processor"
 )

internal/chunk/transform/fileproc/fileproc.go

@@ -44,7 +44,7 @@ func NewSubprocessor(dl Downloader, fp func(ci *slack.Channel, f *slack.File) st
 	}
 }
 
-func (b Subprocessor) Files(ctx context.Context, channel *slack.Channel, msg slack.Message, ff []slack.File) error {
+func (b Subprocessor) Files(ctx context.Context, channel *slack.Channel, _ slack.Message, ff []slack.File) error {
 	for _, f := range ff {
 		if !IsValid(&f) {
 			continue

internal/edge/wrapper.go

@@ -81,3 +81,7 @@ func (w *Wrapper) SearchMessagesContext(ctx context.Context, query string, param
 func (w *Wrapper) SearchFilesContext(ctx context.Context, query string, params slack.SearchParameters) (*slack.SearchFiles, error) {
 	return w.cl.SearchFilesContext(ctx, query, params)
 }
+
+func (w *Wrapper) GetFileInfoContext(ctx context.Context, fileID string, count int, page int) (*slack.File, []slack.Comment, *slack.Paging, error) {
+	return w.cl.GetFileInfoContext(ctx, fileID, count, page)
+}

slackdump.go

@@ -56,6 +56,8 @@ type Slacker interface {
 
 	SearchMessagesContext(ctx context.Context, query string, params slack.SearchParameters) (*slack.SearchMessages, error)
 	SearchFilesContext(ctx context.Context, query string, params slack.SearchParameters) (*slack.SearchFiles, error)
+
+	GetFileInfoContext(ctx context.Context, fileID string, count int, page int) (*slack.File, []slack.Comment, *slack.Paging, error)
 }
 
 // clienter is the interface with some functions of slack.Client with the sole

stream/conversation.go

@@ -171,6 +171,7 @@ func (we *Result) Unwrap() error {
 	return we.Err
 }
 
+// channel fetches the channel data as defined in req, calling callback function for each API response.
 func (cs *Stream) channel(ctx context.Context, req request, callback func(mm []slack.Message, isLast bool) error) error {
 	ctx, task := trace.NewTask(ctx, "channel")
 	defer task.End()

stream/stream.go

@@ -47,6 +47,7 @@ type Slacker interface {
 
 	SearchMessagesContext(ctx context.Context, query string, params slack.SearchParameters) (*slack.SearchMessages, error)
 	SearchFilesContext(ctx context.Context, query string, params slack.SearchParameters) (*slack.SearchFiles, error)
+	GetFileInfoContext(ctx context.Context, fileID string, count int, page int) (*slack.File, []slack.Comment, *slack.Paging, error)
 }
 
 // Stream is used to fetch conversations from Slack.  It is safe for concurrent

stream/stream_workers.go

@@ -2,7 +2,9 @@ package stream
 
 import (
 	"context"
+	"errors"
 	"fmt"
+	"log/slog"
 	"runtime/trace"
 
 	"github.com/rusq/slack"
@@ -28,6 +30,12 @@ func (cs *Stream) channelWorker(ctx context.Context, proc processor.Conversation
 				results <- Result{Type: RTChannel, ChannelID: req.sl.Channel, Err: err}
 				continue
 			}
+			if channel.Properties != nil && !channel.Properties.Canvas.IsEmpty {
+				if err := cs.canvas(ctx, proc, channel, channel.Properties.Canvas.FileId); err != nil {
+					// ignore canvas errors
+					slog.Warn("canvas error: %s", "err", err)
+				}
+			}
 			if err := cs.channel(ctx, req, func(mm []slack.Message, isLast bool) error {
 				n, err := procChanMsg(ctx, proc, threadC, channel, isLast, mm)
 				if err != nil {
@@ -114,7 +122,7 @@ func (cs *Stream) channelInfoWorker(ctx context.Context, proc processor.ChannelI
 
 			if _, err := infoFetcher(ctx, proc, id, ""); err != nil {
 				// if _, err := cs.procChannelInfo(ctx, proc, id, ""); err != nil {
-				srC <- Result{Type: RTChannelInfo, ChannelID: id, Err: fmt.Errorf("channelInfoWorker: %s: %s", id, err)}
+				srC <- Result{Type: RTChannelInfo, ChannelID: id, Err: fmt.Errorf("channelInfoWorker: %s: %w", id, err)}
 			}
 			seen[id] = struct{}{}
 		}
@@ -143,9 +151,26 @@ func (cs *Stream) channelUsersWorker(ctx context.Context, proc processor.Channel
 			}
 
 			if _, err := cs.procChannelUsers(ctx, proc, id, ""); err != nil {
-				srC <- Result{Type: RTChannelUsers, ChannelID: id, Err: fmt.Errorf("channelUsersWorker: %s: %s", id, err)}
+				srC <- Result{Type: RTChannelUsers, ChannelID: id, Err: fmt.Errorf("channelUsersWorker: %s: %w", id, err)}
 			}
 			seen[id] = struct{}{}
 		}
 	}
 }
+
+func (cs *Stream) canvas(ctx context.Context, proc processor.Conversations, channel *slack.Channel, fileId string) error {
+	if fileId == "" {
+		return nil
+	}
+	file, _, _, err := cs.client.GetFileInfoContext(ctx, fileId, 0, 1)
+	if err != nil {
+		return fmt.Errorf("canvas: %s: %w", fileId, err)
+	}
+	if file == nil {
+		return errors.New("canvas: file not found")
+	}
+	if err := proc.Files(ctx, channel, slack.Message{}, []slack.File{*file}); err != nil {
+		return fmt.Errorf("canvas: %s: %w", fileId, err)
+	}
+	return nil
+}

stream/stream_workers_test.go

@@ -0,0 +1,118 @@
+package stream
+
+import (
+	"context"
+	"errors"
+	"testing"
+
+	"github.com/rusq/slack"
+	"github.com/stretchr/testify/assert"
+	"go.uber.org/mock/gomock"
+
+	"github.com/rusq/slackdump/v3/internal/fixtures"
+	"github.com/rusq/slackdump/v3/mocks/mock_processor"
+	"github.com/rusq/slackdump/v3/stream/mock_stream"
+)
+
+func TestStream_canvas(t *testing.T) {
+	testChannel := fixtures.Load[[]*slack.Channel](fixtures.TestChannels)[0]
+	type args struct {
+		ctx context.Context
+		// proc    processor.Conversations
+		channel *slack.Channel
+		fileId  string
+	}
+	tests := []struct {
+		name     string
+		fields   *Stream
+		args     args
+		expectFn func(ms *mock_stream.MockSlacker, mc *mock_processor.MockConversations)
+		wantErr  bool
+	}{
+		{
+			name:   "file ID is empty",
+			fields: &Stream{},
+			args: args{
+				ctx:     context.Background(),
+				channel: &slack.Channel{},
+				fileId:  "",
+			},
+			wantErr: false,
+		},
+		{
+			name:   "getfileinfocontext returns an error",
+			fields: &Stream{},
+			args: args{
+				ctx:    context.Background(),
+				fileId: "F123456",
+			},
+			expectFn: func(ms *mock_stream.MockSlacker, mc *mock_processor.MockConversations) {
+				ms.EXPECT().GetFileInfoContext(gomock.Any(), "F123456", 0, 1).Return(nil, nil, nil, errors.New("getfileinfocontext error"))
+			},
+			wantErr: true,
+		},
+		{
+			name:   "file not found",
+			fields: &Stream{},
+			args: args{
+				ctx:    context.Background(),
+				fileId: "F123456",
+			},
+			expectFn: func(ms *mock_stream.MockSlacker, mc *mock_processor.MockConversations) {
+				ms.EXPECT().GetFileInfoContext(gomock.Any(), "F123456", 0, 1).Return(nil, nil, nil, nil)
+			},
+			wantErr: true,
+		},
+		{
+			name:   "success",
+			fields: &Stream{},
+			args: args{
+				ctx:     context.Background(),
+				channel: testChannel,
+				fileId:  "F123456",
+			},
+			expectFn: func(ms *mock_stream.MockSlacker, mc *mock_processor.MockConversations) {
+				ms.EXPECT().
+					GetFileInfoContext(gomock.Any(), "F123456", 0, 1).
+					Return(&slack.File{ID: "F123456"}, nil, nil, nil)
+				mc.EXPECT().
+					Files(gomock.Any(), testChannel, slack.Message{}, []slack.File{{ID: "F123456"}}).
+					Return(nil)
+			},
+			wantErr: false,
+		},
+		{
+			name:   "processor returns an error",
+			fields: &Stream{},
+			args: args{
+				ctx:     context.Background(),
+				channel: testChannel,
+				fileId:  "F123456",
+			},
+			expectFn: func(ms *mock_stream.MockSlacker, mc *mock_processor.MockConversations) {
+				ms.EXPECT().
+					GetFileInfoContext(gomock.Any(), "F123456", 0, 1).
+					Return(&slack.File{ID: "F123456"}, nil, nil, nil)
+				mc.EXPECT().
+					Files(gomock.Any(), testChannel, slack.Message{}, []slack.File{{ID: "F123456"}}).
+					Return(assert.AnError)
+			},
+			wantErr: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ctrl := gomock.NewController(t)
+			ms := mock_stream.NewMockSlacker(ctrl)
+			mc := mock_processor.NewMockConversations(ctrl)
+			if tt.expectFn != nil {
+				tt.expectFn(ms, mc)
+			}
+			cs := tt.fields
+			cs.client = ms
+			if err := cs.canvas(tt.args.ctx, mc, tt.args.channel, tt.args.fileId); (err != nil) != tt.wantErr {
+				t.Errorf("Stream.canvas() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}