mirror of
https://github.com/matrix-org/dendrite
synced 2024-07-04 12:08:40 +02:00
5e9dce1c0c
* syncapi: Rename and split out tokens Previously we used the badly named `PaginationToken` which was used for both `/sync` and `/messages` requests. This quickly became confusing because named fields like `PDUPosition` meant different things depending on the token type. Instead, we now have two token types: `TopologyToken` and `StreamingToken`, both of which have fields which make more sense for their specific situations. Updated the codebase to use one or the other. `PaginationToken` still lives on as `syncToken`, an unexported type which both tokens rely on. This allows us to guarantee that the specific mappings of positions to a string remain solely under the control of the `types` package. This enables us to move high-level conceptual things like "decrement this topological token" to function calls e.g `TopologicalToken.Decrement()`. Currently broken because `/messages` seemingly used both stream and topological tokens, though I need to confirm this. * final tweaks/hacks * spurious logging * Review comments and linting
79 lines
2.3 KiB
Go
79 lines
2.3 KiB
Go
// Copyright 2017 Vector Creations Ltd
|
|
//
|
|
// 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 sync
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/matrix-org/dendrite/clientapi/auth/authtypes"
|
|
|
|
"github.com/matrix-org/dendrite/syncapi/types"
|
|
"github.com/matrix-org/util"
|
|
log "github.com/sirupsen/logrus"
|
|
)
|
|
|
|
const defaultSyncTimeout = time.Duration(0)
|
|
const defaultTimelineLimit = 20
|
|
|
|
// syncRequest represents a /sync request, with sensible defaults/sanity checks applied.
|
|
type syncRequest struct {
|
|
ctx context.Context
|
|
device authtypes.Device
|
|
limit int
|
|
timeout time.Duration
|
|
since *types.StreamingToken // nil means that no since token was supplied
|
|
wantFullState bool
|
|
log *log.Entry
|
|
}
|
|
|
|
func newSyncRequest(req *http.Request, device authtypes.Device) (*syncRequest, error) {
|
|
timeout := getTimeout(req.URL.Query().Get("timeout"))
|
|
fullState := req.URL.Query().Get("full_state")
|
|
wantFullState := fullState != "" && fullState != "false"
|
|
var since *types.StreamingToken
|
|
sinceStr := req.URL.Query().Get("since")
|
|
if sinceStr != "" {
|
|
tok, err := types.NewStreamTokenFromString(sinceStr)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
since = &tok
|
|
}
|
|
// TODO: Additional query params: set_presence, filter
|
|
return &syncRequest{
|
|
ctx: req.Context(),
|
|
device: device,
|
|
timeout: timeout,
|
|
since: since,
|
|
wantFullState: wantFullState,
|
|
limit: defaultTimelineLimit, // TODO: read from filter
|
|
log: util.GetLogger(req.Context()),
|
|
}, nil
|
|
}
|
|
|
|
func getTimeout(timeoutMS string) time.Duration {
|
|
if timeoutMS == "" {
|
|
return defaultSyncTimeout
|
|
}
|
|
i, err := strconv.Atoi(timeoutMS)
|
|
if err != nil {
|
|
return defaultSyncTimeout
|
|
}
|
|
return time.Duration(i) * time.Millisecond
|
|
}
|