parent
0dc4ceaa2d
commit
6b5996db17
|
@ -0,0 +1,38 @@
|
||||||
|
// Copyright 2020 The Matrix.org Foundation C.I.C.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package api
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// UserInternalAPI is the internal API for information about users and devices.
|
||||||
|
type UserInternalAPI interface {
|
||||||
|
QueryProfile(ctx context.Context, req *QueryProfileRequest, res *QueryProfileResponse) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueryProfileRequest is the request for QueryProfile
|
||||||
|
type QueryProfileRequest struct {
|
||||||
|
// The user ID to query
|
||||||
|
UserID string
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueryProfileResponse is the response for QueryProfile
|
||||||
|
type QueryProfileResponse struct {
|
||||||
|
// True if the user has been created. Querying for a profile does not create them.
|
||||||
|
UserExists bool
|
||||||
|
// The current display name if set.
|
||||||
|
DisplayName string
|
||||||
|
// The current avatar URL if set.
|
||||||
|
AvatarURL string
|
||||||
|
}
|
|
@ -0,0 +1,53 @@
|
||||||
|
// Copyright 2020 The Matrix.org Foundation C.I.C.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/matrix-org/dendrite/clientapi/auth/storage/accounts"
|
||||||
|
"github.com/matrix-org/dendrite/clientapi/auth/storage/devices"
|
||||||
|
"github.com/matrix-org/dendrite/userapi/api"
|
||||||
|
"github.com/matrix-org/gomatrixserverlib"
|
||||||
|
)
|
||||||
|
|
||||||
|
type UserInternalAPI struct {
|
||||||
|
AccountDB accounts.Database
|
||||||
|
DeviceDB devices.Database
|
||||||
|
ServerName gomatrixserverlib.ServerName
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *UserInternalAPI) QueryProfile(ctx context.Context, req *api.QueryProfileRequest, res *api.QueryProfileResponse) error {
|
||||||
|
local, domain, err := gomatrixserverlib.SplitID('@', req.UserID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if domain != a.ServerName {
|
||||||
|
return fmt.Errorf("cannot query profile of remote users: got %s want %s", domain, a.ServerName)
|
||||||
|
}
|
||||||
|
prof, err := a.AccountDB.GetProfileByLocalpart(ctx, local)
|
||||||
|
if err != nil {
|
||||||
|
if err == sql.ErrNoRows {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
res.UserExists = true
|
||||||
|
res.AvatarURL = prof.AvatarURL
|
||||||
|
res.DisplayName = prof.DisplayName
|
||||||
|
return nil
|
||||||
|
}
|
|
@ -0,0 +1,62 @@
|
||||||
|
// Copyright 2020 The Matrix.org Foundation C.I.C.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package inthttp
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"github.com/matrix-org/dendrite/internal/httputil"
|
||||||
|
"github.com/matrix-org/dendrite/userapi/api"
|
||||||
|
"github.com/opentracing/opentracing-go"
|
||||||
|
)
|
||||||
|
|
||||||
|
// HTTP paths for the internal HTTP APIs
|
||||||
|
const (
|
||||||
|
QueryProfilePath = "/userapi/queryProfile"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NewUserAPIClient creates a UserInternalAPI implemented by talking to a HTTP POST API.
|
||||||
|
// If httpClient is nil an error is returned
|
||||||
|
func NewUserAPIClient(
|
||||||
|
apiURL string,
|
||||||
|
httpClient *http.Client,
|
||||||
|
) (api.UserInternalAPI, error) {
|
||||||
|
if httpClient == nil {
|
||||||
|
return nil, errors.New("NewUserAPIClient: httpClient is <nil>")
|
||||||
|
}
|
||||||
|
return &httpUserInternalAPI{
|
||||||
|
apiURL: apiURL,
|
||||||
|
httpClient: httpClient,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type httpUserInternalAPI struct {
|
||||||
|
apiURL string
|
||||||
|
httpClient *http.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *httpUserInternalAPI) QueryProfile(
|
||||||
|
ctx context.Context,
|
||||||
|
request *api.QueryProfileRequest,
|
||||||
|
response *api.QueryProfileResponse,
|
||||||
|
) error {
|
||||||
|
span, ctx := opentracing.StartSpanFromContext(ctx, "QueryProfile")
|
||||||
|
defer span.Finish()
|
||||||
|
|
||||||
|
apiURL := h.apiURL + QueryProfilePath
|
||||||
|
return httputil.PostJSON(ctx, span, h.httpClient, apiURL, request, response)
|
||||||
|
}
|
|
@ -0,0 +1,41 @@
|
||||||
|
// Copyright 2020 The Matrix.org Foundation C.I.C.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package inthttp
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"github.com/gorilla/mux"
|
||||||
|
"github.com/matrix-org/dendrite/internal/httputil"
|
||||||
|
"github.com/matrix-org/dendrite/userapi/api"
|
||||||
|
"github.com/matrix-org/util"
|
||||||
|
)
|
||||||
|
|
||||||
|
func AddRoutes(internalAPIMux *mux.Router, s api.UserInternalAPI) {
|
||||||
|
internalAPIMux.Handle(QueryProfilePath,
|
||||||
|
httputil.MakeInternalAPI("queryProfile", func(req *http.Request) util.JSONResponse {
|
||||||
|
request := api.QueryProfileRequest{}
|
||||||
|
response := api.QueryProfileResponse{}
|
||||||
|
if err := json.NewDecoder(req.Body).Decode(&request); err != nil {
|
||||||
|
return util.MessageResponse(http.StatusBadRequest, err.Error())
|
||||||
|
}
|
||||||
|
if err := s.QueryProfile(req.Context(), &request, &response); err != nil {
|
||||||
|
return util.ErrorResponse(err)
|
||||||
|
}
|
||||||
|
return util.JSONResponse{Code: http.StatusOK, JSON: &response}
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
}
|
|
@ -0,0 +1,41 @@
|
||||||
|
// Copyright 2020 The Matrix.org Foundation C.I.C.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package userapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/gorilla/mux"
|
||||||
|
"github.com/matrix-org/dendrite/clientapi/auth/storage/accounts"
|
||||||
|
"github.com/matrix-org/dendrite/clientapi/auth/storage/devices"
|
||||||
|
"github.com/matrix-org/dendrite/userapi/api"
|
||||||
|
"github.com/matrix-org/dendrite/userapi/internal"
|
||||||
|
"github.com/matrix-org/dendrite/userapi/inthttp"
|
||||||
|
"github.com/matrix-org/gomatrixserverlib"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AddInternalRoutes registers HTTP handlers for the internal API. Invokes functions
|
||||||
|
// on the given input API.
|
||||||
|
func AddInternalRoutes(router *mux.Router, intAPI api.UserInternalAPI) {
|
||||||
|
inthttp.AddRoutes(router, intAPI)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewInternalAPI returns a concerete implementation of the internal API. Callers
|
||||||
|
// can call functions directly on the returned API or via an HTTP interface using AddInternalRoutes.
|
||||||
|
func NewInternalAPI(accountDB accounts.Database, deviceDB devices.Database, serverName gomatrixserverlib.ServerName) api.UserInternalAPI {
|
||||||
|
return &internal.UserInternalAPI{
|
||||||
|
AccountDB: accountDB,
|
||||||
|
DeviceDB: deviceDB,
|
||||||
|
ServerName: serverName,
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,138 @@
|
||||||
|
package userapi_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"reflect"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/gorilla/mux"
|
||||||
|
"github.com/matrix-org/dendrite/clientapi/auth/storage/accounts"
|
||||||
|
"github.com/matrix-org/dendrite/clientapi/auth/storage/devices"
|
||||||
|
"github.com/matrix-org/dendrite/internal/httputil"
|
||||||
|
"github.com/matrix-org/dendrite/userapi"
|
||||||
|
"github.com/matrix-org/dendrite/userapi/api"
|
||||||
|
"github.com/matrix-org/dendrite/userapi/inthttp"
|
||||||
|
"github.com/matrix-org/gomatrixserverlib"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
serverName = gomatrixserverlib.ServerName("example.com")
|
||||||
|
)
|
||||||
|
|
||||||
|
func MustMakeInternalAPI(t *testing.T) (api.UserInternalAPI, accounts.Database, devices.Database) {
|
||||||
|
accountDB, err := accounts.NewDatabase("file::memory:", nil, serverName)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to create account DB: %s", err)
|
||||||
|
}
|
||||||
|
deviceDB, err := devices.NewDatabase("file::memory:", nil, serverName)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to create device DB: %s", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return userapi.NewInternalAPI(accountDB, deviceDB, serverName), accountDB, deviceDB
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestQueryProfile(t *testing.T) {
|
||||||
|
aliceAvatarURL := "mxc://example.com/alice"
|
||||||
|
aliceDisplayName := "Alice"
|
||||||
|
userAPI, accountDB, _ := MustMakeInternalAPI(t)
|
||||||
|
_, err := accountDB.CreateAccount(context.TODO(), "alice", "foobar", "")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to make account: %s", err)
|
||||||
|
}
|
||||||
|
if err := accountDB.SetAvatarURL(context.TODO(), "alice", aliceAvatarURL); err != nil {
|
||||||
|
t.Fatalf("failed to set avatar url: %s", err)
|
||||||
|
}
|
||||||
|
if err := accountDB.SetDisplayName(context.TODO(), "alice", aliceDisplayName); err != nil {
|
||||||
|
t.Fatalf("failed to set display name: %s", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
testCases := []struct {
|
||||||
|
req api.QueryProfileRequest
|
||||||
|
wantRes api.QueryProfileResponse
|
||||||
|
wantErr error
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
req: api.QueryProfileRequest{
|
||||||
|
UserID: fmt.Sprintf("@alice:%s", serverName),
|
||||||
|
},
|
||||||
|
wantRes: api.QueryProfileResponse{
|
||||||
|
UserExists: true,
|
||||||
|
AvatarURL: aliceAvatarURL,
|
||||||
|
DisplayName: aliceDisplayName,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: api.QueryProfileRequest{
|
||||||
|
UserID: fmt.Sprintf("@bob:%s", serverName),
|
||||||
|
},
|
||||||
|
wantRes: api.QueryProfileResponse{
|
||||||
|
UserExists: false,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
req: api.QueryProfileRequest{
|
||||||
|
UserID: "@alice:wrongdomain.com",
|
||||||
|
},
|
||||||
|
wantErr: fmt.Errorf("wrong domain"),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
runCases := func(testAPI api.UserInternalAPI) {
|
||||||
|
for _, tc := range testCases {
|
||||||
|
var gotRes api.QueryProfileResponse
|
||||||
|
gotErr := testAPI.QueryProfile(context.TODO(), &tc.req, &gotRes)
|
||||||
|
if tc.wantErr == nil && gotErr != nil || tc.wantErr != nil && gotErr == nil {
|
||||||
|
t.Errorf("QueryProfile error, got %s want %s", gotErr, tc.wantErr)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(tc.wantRes, gotRes) {
|
||||||
|
t.Errorf("QueryProfile response got %+v want %+v", gotRes, tc.wantRes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Run("HTTP API", func(t *testing.T) {
|
||||||
|
router := mux.NewRouter().PathPrefix(httputil.InternalPathPrefix).Subrouter()
|
||||||
|
userapi.AddInternalRoutes(router, userAPI)
|
||||||
|
apiURL, cancel := listenAndServe(t, router)
|
||||||
|
defer cancel()
|
||||||
|
httpAPI, err := inthttp.NewUserAPIClient(apiURL, &http.Client{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to create HTTP client")
|
||||||
|
}
|
||||||
|
runCases(httpAPI)
|
||||||
|
})
|
||||||
|
t.Run("Monolith", func(t *testing.T) {
|
||||||
|
runCases(userAPI)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func listenAndServe(t *testing.T, router *mux.Router) (apiURL string, cancel func()) {
|
||||||
|
listener, err := net.Listen("tcp", ":0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to listen: %s", err)
|
||||||
|
}
|
||||||
|
port := listener.Addr().(*net.TCPAddr).Port
|
||||||
|
srv := http.Server{}
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
srv.Handler = router
|
||||||
|
err := srv.Serve(listener)
|
||||||
|
if err != nil && err != http.ErrServerClosed {
|
||||||
|
t.Logf("Listen failed: %s", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return fmt.Sprintf("http://localhost:%d", port), func() {
|
||||||
|
srv.Shutdown(context.Background())
|
||||||
|
wg.Wait()
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue