Add presence module V2 (#2312)

* Syncapi presence

* Clientapi http presence handler

* Why is this here?

* Missing files

* FederationAPI presence implementation

* Add new presence stream

* Pinecone update

* Pinecone update

* Add passing tests

* Make linter happy

* Add presence producer

* Add presence config option

* Set user to unavailable after x minutes

* Only set currently_active if online
Avoid unneeded presence updates when syncing

* Tweaks

* Query devices for last_active_ts
Fixes & tweaks

* Export SharedUsers/SharedUsers

* Presence stream in MemoryStorage

* Remove status_msg_nil

* Fix sytest crashes

* Make presence types const and use stringer for it

* Change options to allow inbound/outbound presence

* Fix option & typo

* Update configs

Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>

syncapi/types/presence.go

@@ -0,0 +1,75 @@
+// Copyright 2022 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 types
+
+import (
+	"strings"
+	"time"
+
+	"github.com/matrix-org/gomatrixserverlib"
+)
+
+//go:generate stringer -type=Presence -linecomment
+type Presence uint8
+
+const (
+	PresenceUnavailable Presence = iota + 1 // unavailable
+	PresenceOnline                          // online
+	PresenceOffline                         // offline
+)
+
+// PresenceFromString returns the integer representation of the given input presence.
+// Returns false for ok, if input is not a valid presence value.
+func PresenceFromString(input string) (p Presence, ok bool) {
+	for i := 0; i < len(_Presence_index)-1; i++ {
+		l, r := _Presence_index[i], _Presence_index[i+1]
+		if strings.EqualFold(input, _Presence_name[l:r]) {
+			return Presence(i + 1), true
+		}
+	}
+	return 0, false
+}
+
+type PresenceInternal struct {
+	ClientFields PresenceClientResponse
+	StreamPos    StreamPosition              `json:"-"`
+	UserID       string                      `json:"-"`
+	LastActiveTS gomatrixserverlib.Timestamp `json:"-"`
+	Presence     Presence                    `json:"-"`
+}
+
+// Equals compares p1 with p2.
+func (p1 *PresenceInternal) Equals(p2 *PresenceInternal) bool {
+	return p1.ClientFields.Presence == p2.ClientFields.Presence &&
+		p1.ClientFields.StatusMsg == p2.ClientFields.StatusMsg &&
+		p1.UserID == p2.UserID
+}
+
+// CurrentlyActive returns the current active state.
+func (p *PresenceInternal) CurrentlyActive() bool {
+	return time.Since(p.LastActiveTS.Time()).Minutes() < 5
+}
+
+// LastActiveAgo returns the time since the LastActiveTS in milliseconds.
+func (p *PresenceInternal) LastActiveAgo() int64 {
+	return time.Since(p.LastActiveTS.Time()).Milliseconds()
+}
+
+type PresenceClientResponse struct {
+	CurrentlyActive *bool   `json:"currently_active,omitempty"`
+	LastActiveAgo   int64   `json:"last_active_ago,omitempty"`
+	Presence        string  `json:"presence"`
+	StatusMsg       *string `json:"status_msg,omitempty"`
+}

syncapi/types/presence_string.go

@@ -0,0 +1,26 @@
+// Code generated by "stringer -type=Presence -linecomment"; DO NOT EDIT.
+
+package types
+
+import "strconv"
+
+func _() {
+	// An "invalid array index" compiler error signifies that the constant values have changed.
+	// Re-run the stringer command to generate them again.
+	var x [1]struct{}
+	_ = x[PresenceUnavailable-1]
+	_ = x[PresenceOnline-2]
+	_ = x[PresenceOffline-3]
+}
+
+const _Presence_name = "unavailableonlineoffline"
+
+var _Presence_index = [...]uint8{0, 11, 17, 24}
+
+func (i Presence) String() string {
+	i -= 1
+	if i >= Presence(len(_Presence_index)-1) {
+		return "Presence(" + strconv.FormatInt(int64(i+1), 10) + ")"
+	}
+	return _Presence_name[_Presence_index[i]:_Presence_index[i+1]]
+}

syncapi/types/presence_test.go

@@ -0,0 +1,42 @@
+package types
+
+import "testing"
+
+func TestPresenceFromString(t *testing.T) {
+	tests := []struct {
+		name       string
+		input      string
+		wantStatus Presence
+		wantOk     bool
+	}{
+		{
+			name:       "presence unavailable",
+			input:      "unavailable",
+			wantStatus: PresenceUnavailable,
+			wantOk:     true,
+		},
+		{
+			name:       "presence online",
+			input:      "OnLINE",
+			wantStatus: PresenceOnline,
+			wantOk:     true,
+		},
+		{
+			name:       "unknown presence",
+			input:      "unknown",
+			wantStatus: 0,
+			wantOk:     false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, got1 := PresenceFromString(tt.input)
+			if got != tt.wantStatus {
+				t.Errorf("PresenceFromString() got = %v, want %v", got, tt.wantStatus)
+			}
+			if got1 != tt.wantOk {
+				t.Errorf("PresenceFromString() got1 = %v, want %v", got1, tt.wantOk)
+			}
+		})
+	}
+}

syncapi/types/types.go

@@ -103,6 +103,7 @@ type StreamingToken struct {
 	AccountDataPosition      StreamPosition
 	DeviceListPosition       StreamPosition
 	NotificationDataPosition StreamPosition
+	PresencePosition         StreamPosition
 }
 
 // This will be used as a fallback by json.Marshal.
@@ -118,11 +119,12 @@ func (s *StreamingToken) UnmarshalText(text []byte) (err error) {
 
 func (t StreamingToken) String() string {
 	posStr := fmt.Sprintf(
-		"s%d_%d_%d_%d_%d_%d_%d_%d",
+		"s%d_%d_%d_%d_%d_%d_%d_%d_%d",
 		t.PDUPosition, t.TypingPosition,
 		t.ReceiptPosition, t.SendToDevicePosition,
 		t.InvitePosition, t.AccountDataPosition,
 		t.DeviceListPosition, t.NotificationDataPosition,
+		t.PresencePosition,
 	)
 	return posStr
 }
@@ -146,12 +148,14 @@ func (t *StreamingToken) IsAfter(other StreamingToken) bool {
 		return true
 	case t.NotificationDataPosition > other.NotificationDataPosition:
 		return true
+	case t.PresencePosition > other.PresencePosition:
+		return true
 	}
 	return false
 }
 
 func (t *StreamingToken) IsEmpty() bool {
-	return t == nil || t.PDUPosition+t.TypingPosition+t.ReceiptPosition+t.SendToDevicePosition+t.InvitePosition+t.AccountDataPosition+t.DeviceListPosition+t.NotificationDataPosition == 0
+	return t == nil || t.PDUPosition+t.TypingPosition+t.ReceiptPosition+t.SendToDevicePosition+t.InvitePosition+t.AccountDataPosition+t.DeviceListPosition+t.NotificationDataPosition+t.PresencePosition == 0
 }
 
 // WithUpdates returns a copy of the StreamingToken with updates applied from another StreamingToken.
@@ -192,6 +196,9 @@ func (t *StreamingToken) ApplyUpdates(other StreamingToken) {
 	if other.NotificationDataPosition > t.NotificationDataPosition {
 		t.NotificationDataPosition = other.NotificationDataPosition
 	}
+	if other.PresencePosition > t.PresencePosition {
+		t.PresencePosition = other.PresencePosition
+	}
 }
 
 type TopologyToken struct {
@@ -284,7 +291,7 @@ func NewStreamTokenFromString(tok string) (token StreamingToken, err error) {
 	// s478_0_0_0_0_13.dl-0-2 but we have now removed partitioned stream positions
 	tok = strings.Split(tok, ".")[0]
 	parts := strings.Split(tok[1:], "_")
-	var positions [8]StreamPosition
+	var positions [9]StreamPosition
 	for i, p := range parts {
 		if i >= len(positions) {
 			break
@@ -306,6 +313,7 @@ func NewStreamTokenFromString(tok string) (token StreamingToken, err error) {
 		AccountDataPosition:      positions[5],
 		DeviceListPosition:       positions[6],
 		NotificationDataPosition: positions[7],
+		PresencePosition:         positions[8],
 	}
 	return token, nil
 }

syncapi/types/types_test.go

@@ -9,10 +9,10 @@ import (
 
 func TestSyncTokens(t *testing.T) {
 	shouldPass := map[string]string{
-		"s4_0_0_0_0_0_0_0": StreamingToken{4, 0, 0, 0, 0, 0, 0, 0}.String(),
-		"s3_1_0_0_0_0_2_0": StreamingToken{3, 1, 0, 0, 0, 0, 2, 0}.String(),
-		"s3_1_2_3_5_0_0_0": StreamingToken{3, 1, 2, 3, 5, 0, 0, 0}.String(),
-		"t3_1":             TopologyToken{3, 1}.String(),
+		"s4_0_0_0_0_0_0_0_3": StreamingToken{4, 0, 0, 0, 0, 0, 0, 0, 3}.String(),
+		"s3_1_0_0_0_0_2_0_5": StreamingToken{3, 1, 0, 0, 0, 0, 2, 0, 5}.String(),
+		"s3_1_2_3_5_0_0_0_6": StreamingToken{3, 1, 2, 3, 5, 0, 0, 0, 6}.String(),
+		"t3_1":               TopologyToken{3, 1}.String(),
 	}
 
 	for a, b := range shouldPass {