feat: add native contact conversation filtering #38
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| module github.com/chatwoot/cli | ||
|
|
||
| go 1.26.6 | ||
|
|
||
| require ( | ||
| github.com/alecthomas/kong v1.16.0 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "reflect" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/chatwoot/cli/internal/config" | ||
| "github.com/chatwoot/cli/internal/sdk" | ||
| ) | ||
|
|
||
| func TestContactConversationCommandsUseNativeFiltersAndPagination(t *testing.T) { | ||
| setupTestEnv(t) | ||
|
|
||
| wantFilters := []sdk.ConversationFilter{ | ||
| {AttributeKey: "contact_id", FilterOperator: "equal_to", Values: []string{"123"}, QueryOperator: "AND"}, | ||
| {AttributeKey: "status", FilterOperator: "equal_to", Values: []string{"open"}, QueryOperator: "AND"}, | ||
| {AttributeKey: "inbox_id", FilterOperator: "equal_to", Values: []string{"4"}, QueryOperator: "AND"}, | ||
| {AttributeKey: "team_id", FilterOperator: "equal_to", Values: []string{"7"}, QueryOperator: "AND"}, | ||
| {AttributeKey: "labels", FilterOperator: "equal_to", Values: []string{"billing", "vip"}}, | ||
| } | ||
|
|
||
| requestCount := 0 | ||
| server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| requestCount++ | ||
| if r.Method != http.MethodPost { | ||
| t.Errorf("method = %s, want POST", r.Method) | ||
| } | ||
| if r.URL.Path != "/api/v1/accounts/1/conversations/filter" { | ||
| t.Errorf("path = %s", r.URL.Path) | ||
| } | ||
| if got := r.URL.Query().Get("page"); got != "2" { | ||
| t.Errorf("page = %q, want 2", got) | ||
| } | ||
|
|
||
| var body struct { | ||
| Payload []sdk.ConversationFilter `json:"payload"` | ||
| } | ||
| if err := json.NewDecoder(r.Body).Decode(&body); err != nil { | ||
| t.Errorf("decode request: %v", err) | ||
| return | ||
| } | ||
| if !reflect.DeepEqual(body.Payload, wantFilters) { | ||
| t.Errorf("filters = %#v, want %#v", body.Payload, wantFilters) | ||
| return | ||
| } | ||
|
|
||
| w.Header().Set("Content-Type", "application/json") | ||
| _, _ = w.Write([]byte(`{"meta":{"all_count":1},"payload":[{"id":88,"status":"open","meta":{"channel":"Channel::Email"}}]}`)) | ||
| })) | ||
| defer server.Close() | ||
|
|
||
| if err := config.Save(&config.Config{BaseURL: server.URL, AccountID: 1}); err != nil { | ||
| t.Fatalf("config.Save: %v", err) | ||
| } | ||
| app, err := NewApp(&CLI{Output: "json"}, false, "test") | ||
| if err != nil { | ||
| t.Fatalf("NewApp: %v", err) | ||
| } | ||
| var out bytes.Buffer | ||
| app.Printer.Writer = &out | ||
|
|
||
| err = (&ContactConversationsCmd{ | ||
| ID: 123, | ||
| Status: "open", | ||
| Inbox: 4, | ||
| Assignee: "all", | ||
| Team: 7, | ||
| Label: []string{"billing", "vip"}, | ||
| Page: 2, | ||
| }).Run(app) | ||
| if err != nil { | ||
| t.Fatalf("Run: %v", err) | ||
| } | ||
| if !strings.Contains(out.String(), `"id": 88`) { | ||
| t.Fatalf("output = %s, want filtered conversation", out.String()) | ||
| } | ||
|
|
||
| out.Reset() | ||
| err = (&ConvsCmd{ | ||
| Contact: 123, | ||
| Status: "open", | ||
| Inbox: 4, | ||
| Assignee: "all", | ||
| Team: 7, | ||
| Label: []string{"billing", "vip"}, | ||
| Page: 2, | ||
| }).Run(app) | ||
| if err != nil { | ||
| t.Fatalf("ConvsCmd.Run: %v", err) | ||
| } | ||
| if requestCount != 2 { | ||
| t.Fatalf("filter request count = %d, want 2", requestCount) | ||
| } | ||
| } | ||
|
|
||
| func TestConvsRejectsQueryWithContactFilter(t *testing.T) { | ||
| err := (&ConvsCmd{Contact: 123, Query: "refund"}).Run(&App{}) | ||
| if err == nil || !strings.Contains(err.Error(), "--query cannot be combined with --contact") { | ||
| t.Fatalf("error = %v", err) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a caller explicitly supplies
--contact 0or a negative ID, this condition treats the flag as absent and executes the ordinary conversation-list request, potentially returning unrelated conversations instead of reporting invalid input. This also bypasses theContactID <= 0validation infilterConversations, so scripts can silently operate on the wrong result set; track whether the flag was supplied or validate it before choosing the request path.Useful? React with 👍 / 👎.