Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(matrix): add missing txid to send message call #416

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
5 changes: 3 additions & 2 deletions pkg/services/matrix/matrix.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ package matrix

import (
"fmt"
"net/url"

"github.com/containrrr/shoutrrr/pkg/format"
"github.com/containrrr/shoutrrr/pkg/services/standard"
t "github.com/containrrr/shoutrrr/pkg/types"
"net/url"
)

// Scheme is the identifying part of this service's configuration URL
Expand Down Expand Up @@ -49,7 +50,7 @@ func (s *Service) Send(message string, params *t.Params) error {

if len(errors) > 0 {
for _, err := range errors {
s.Logf("error sending message: %w", err)
s.Logf("error sending message: %v", err)
}
return fmt.Errorf("%v error(s) sending message, with initial error: %v", len(errors), errors[0])
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/services/matrix/matrix_api.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type identifierType string
const (
apiLogin = "/_matrix/client/r0/login"
apiRoomJoin = "/_matrix/client/r0/join/%s"
apiSendMessage = "/_matrix/client/r0/rooms/%s/send/m.room.message"
apiSendMessage = "/_matrix/client/r0/rooms/%s/send/m.room.message/%v"
apiJoinedRooms = "/_matrix/client/r0/joined_rooms"

contentType = "application/json"
Expand Down
67 changes: 32 additions & 35 deletions pkg/services/matrix/matrix_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
"bytes"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"strings"
"sync/atomic"

"github.com/containrrr/shoutrrr/pkg/types"
"github.com/containrrr/shoutrrr/pkg/util"
Expand All @@ -17,6 +19,7 @@
apiURL url.URL
accessToken string
logger types.StdLogger
counter uint64
}

func newClient(host string, disableTLS bool, logger types.StdLogger) (c *client) {
Expand All @@ -41,6 +44,10 @@
return c
}

func (c *client) txId() uint64 {
return atomic.AddUint64(&c.counter, 1)
}

func (c *client) useToken(token string) {
c.accessToken = token
c.updateAccessToken()
Expand Down Expand Up @@ -127,6 +134,10 @@
return append(errors, fmt.Errorf("failed to get joined rooms: %w", err))
}

if len(joinedRooms) == 0 {
return append(errors, fmt.Errorf("no rooms has been joined"))
}

Check warning on line 139 in pkg/services/matrix/matrix_client.go

View check run for this annotation

Codecov / codecov/patch

pkg/services/matrix/matrix_client.go#L138-L139

Added lines #L138 - L139 were not covered by tests

// Send to all rooms that are joined
for _, roomID := range joinedRooms {
c.logf("Sending message to '%v'...\n", roomID)
Expand All @@ -148,63 +159,49 @@

func (c *client) sendMessageToRoom(message string, roomID string) error {
resEvent := apiResEvent{}
return c.apiPost(fmt.Sprintf(apiSendMessage, roomID), apiReqSend{
return c.apiPut(fmt.Sprintf(apiSendMessage, roomID, c.txId()), apiReqSend{
MsgType: msgTypeText,
Body: message,
}, &resEvent)
}

func (c *client) apiGet(path string, response interface{}) error {
c.apiURL.Path = path

var err error
var res *http.Response
res, err = http.Get(c.apiURL.String())
if err != nil {
return err
}

var body []byte
defer res.Body.Close()
body, err = ioutil.ReadAll(res.Body)

if res.StatusCode >= 400 {
resError := &apiResError{}
if err == nil {
if err = json.Unmarshal(body, resError); err == nil {
return resError
}
}

return fmt.Errorf("got HTTP %v", res.Status)
}
return c.apiReq(path, "GET", nil, response)
}

if err != nil {
return err
}
func (c *client) apiPost(path string, request interface{}, response interface{}) error {
return c.apiReq(path, "POST", request, response)
}

return json.Unmarshal(body, response)
func (c *client) apiPut(path string, request interface{}, response interface{}) error {
return c.apiReq(path, "PUT", request, response)
}

func (c *client) apiPost(path string, request interface{}, response interface{}) error {
func (c *client) apiReq(path string, method string, request interface{}, response interface{}) error {
c.apiURL.Path = path

var err error
var body []byte
var payload io.Reader = nil
if request != nil {
body, err := json.Marshal(request)
if err != nil {
return err
}

Check warning on line 188 in pkg/services/matrix/matrix_client.go

View check run for this annotation

Codecov / codecov/patch

pkg/services/matrix/matrix_client.go#L187-L188

Added lines #L187 - L188 were not covered by tests
payload = bytes.NewReader(body)
}

body, err = json.Marshal(request)
req, err := http.NewRequest(method, c.apiURL.String(), payload)
if err != nil {
return err
}
req.Header.Set("Content-Type", contentType)

var res *http.Response
res, err = http.Post(c.apiURL.String(), contentType, bytes.NewReader(body))
res, err := http.DefaultClient.Do(req)
if err != nil {
return err
}

defer res.Body.Close()
body, err = ioutil.ReadAll(res.Body)
body, err := ioutil.ReadAll(res.Body)

if res.StatusCode >= 400 {
resError := &apiResError{}
Expand Down
6 changes: 3 additions & 3 deletions pkg/services/matrix/matrix_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -167,13 +167,13 @@ func setupMockResponders() {
mockServer+apiJoinedRooms,
httpmock.NewStringResponder(200, `{ "joined_rooms": [ "!room:mockserver" ] }`))

httpmock.RegisterResponder("POST", mockServer+fmt.Sprintf(apiSendMessage, "%21room:mockserver"),
httpmock.RegisterResponder("PUT", `=~`+mockServer+fmt.Sprintf(apiSendMessage, "%21room:mockserver", `[0-9]+`),
httpmock.NewJsonResponderOrPanic(200, apiResEvent{EventID: "7"}))

httpmock.RegisterResponder("POST", mockServer+fmt.Sprintf(apiSendMessage, "1"),
httpmock.RegisterResponder("PUT", `=~`+mockServer+fmt.Sprintf(apiSendMessage, "1", `[0-9]+`),
httpmock.NewJsonResponderOrPanic(200, apiResEvent{EventID: "8"}))

httpmock.RegisterResponder("POST", mockServer+fmt.Sprintf(apiSendMessage, "2"),
httpmock.RegisterResponder("PUT", `=~`+mockServer+fmt.Sprintf(apiSendMessage, "2", `[0-9]+`),
httpmock.NewJsonResponderOrPanic(200, apiResEvent{EventID: "9"}))

httpmock.RegisterResponder("POST", mockServer+fmt.Sprintf(apiRoomJoin, "%23room1"),
Expand Down
Loading