Update room version descriptors, add error handling

go.mod

@@ -10,7 +10,7 @@ require (
 	github.com/matrix-org/go-http-js-libp2p v0.0.0-20200310180544-7f3fad43b51c
 	github.com/matrix-org/go-sqlite3-js v0.0.0-20200304164012-aa524245b658
 	github.com/matrix-org/gomatrix v0.0.0-20190528120928-7df988a63f26
-	github.com/matrix-org/gomatrixserverlib v0.0.0-20200306154041-df6bb9a3e424
+	github.com/matrix-org/gomatrixserverlib v0.0.0-20200316144058-cc6847798a3f
 	github.com/matrix-org/naffka v0.0.0-20200127221512-0716baaabaf1
 	github.com/matrix-org/util v0.0.0-20190711121626-527ce5ddefc7
 	github.com/mattn/go-sqlite3 v2.0.2+incompatible

go.sum

@@ -138,6 +138,10 @@ github.com/matrix-org/gomatrixserverlib v0.0.0-20200124100636-0c2ec91d1df5 h1:km
 github.com/matrix-org/gomatrixserverlib v0.0.0-20200124100636-0c2ec91d1df5/go.mod h1:FsKa2pWE/bpQql9H7U4boOPXFoJX/QcqaZZ6ijLkaZI=
 github.com/matrix-org/gomatrixserverlib v0.0.0-20200306154041-df6bb9a3e424 h1:H61lT6ckUFIDl9qb636qNomfo0B52lFt73ecioiqF10=
 github.com/matrix-org/gomatrixserverlib v0.0.0-20200306154041-df6bb9a3e424/go.mod h1:FsKa2pWE/bpQql9H7U4boOPXFoJX/QcqaZZ6ijLkaZI=
+github.com/matrix-org/gomatrixserverlib v0.0.0-20200316100021-ac4a53d49690 h1:aQPPypOdoIsquJHhoalRYvKtDoiJfSyyJqOEn6R7yTY=
+github.com/matrix-org/gomatrixserverlib v0.0.0-20200316100021-ac4a53d49690/go.mod h1:FsKa2pWE/bpQql9H7U4boOPXFoJX/QcqaZZ6ijLkaZI=
+github.com/matrix-org/gomatrixserverlib v0.0.0-20200316144058-cc6847798a3f h1:JXSvzG4movqXT1KcdX+XZ9HM61m1FW4rIMFKUM9j/Dk=
+github.com/matrix-org/gomatrixserverlib v0.0.0-20200316144058-cc6847798a3f/go.mod h1:FsKa2pWE/bpQql9H7U4boOPXFoJX/QcqaZZ6ijLkaZI=
 github.com/matrix-org/naffka v0.0.0-20200127221512-0716baaabaf1 h1:osLoFdOy+ChQqVUn2PeTDETFftVkl4w9t/OW18g3lnk=
 github.com/matrix-org/naffka v0.0.0-20200127221512-0716baaabaf1/go.mod h1:cXoYQIENbdWIQHt1SyCo6Bl3C3raHwJ0wgVrXHSqf+A=
 github.com/matrix-org/util v0.0.0-20171127121716-2e2df66af2f5 h1:W7l5CP4V7wPyPb4tYE11dbmeAOwtFQBTW0rf4OonOS8=

roomserver/query/query.go

@@ -20,7 +20,6 @@ import (
 	"context"
 	"encoding/json"
 	"net/http"
-	"strconv"
 
 	"github.com/matrix-org/dendrite/common"
 	"github.com/matrix-org/dendrite/roomserver/api"
@@ -733,10 +732,10 @@ func (r *RoomserverQueryAPI) QueryRoomVersionCapabilities(
 	request *api.QueryRoomVersionCapabilitiesRequest,
 	response *api.QueryRoomVersionCapabilitiesResponse,
 ) error {
-	response.DefaultRoomVersion = strconv.Itoa(int(version.GetDefaultRoomVersion()))
+	response.DefaultRoomVersion = string(version.GetDefaultRoomVersion())
 	response.AvailableRoomVersions = make(map[string]string)
 	for v, desc := range version.GetSupportedRoomVersions() {
-		sv := strconv.Itoa(int(v))
+		sv := string(v)
 		if desc.Stable {
 			response.AvailableRoomVersions[sv] = "stable"
 		} else {

roomserver/storage/postgres/rooms_table.go

@@ -42,13 +42,13 @@ CREATE TABLE IF NOT EXISTS roomserver_rooms (
     state_snapshot_nid BIGINT NOT NULL DEFAULT 0,
     -- The version of the room, which will assist in determining the state resolution
     -- algorithm, event ID format, etc.
-    room_version BIGINT NOT NULL DEFAULT 1
+    room_version TEXT NOT NULL DEFAULT '1'
 );
 `
 
 // Same as insertEventTypeNIDSQL
 const insertRoomNIDSQL = "" +
-	"INSERT INTO roomserver_rooms (room_id) VALUES ($1)" +
+	"INSERT INTO roomserver_rooms (room_id, room_version) VALUES ($1, $2)" +
 	" ON CONFLICT ON CONSTRAINT roomserver_room_id_unique" +
 	" DO NOTHING RETURNING (room_nid)"
 

roomserver/storage/sqlite3/rooms_table.go

@@ -31,13 +31,13 @@ const roomsSchema = `
     latest_event_nids TEXT NOT NULL DEFAULT '[]',
     last_event_sent_nid INTEGER NOT NULL DEFAULT 0,
     state_snapshot_nid INTEGER NOT NULL DEFAULT 0,
-    room_version INTEGER NOT NULL DEFAULT 1
+    room_version TEXT NOT NULL DEFAULT '1'
   );
 `
 
 // Same as insertEventTypeNIDSQL
 const insertRoomNIDSQL = `
-	INSERT INTO roomserver_rooms (room_id) VALUES ($1)
+	INSERT INTO roomserver_rooms (room_id, room_version) VALUES ($1, $2)
 	  ON CONFLICT DO NOTHING;
 `
 

roomserver/version/version.go

@@ -15,84 +15,58 @@
 package version
 
 import (
-	"errors"
+	"fmt"
 
-	"github.com/matrix-org/dendrite/roomserver/state"
+	"github.com/matrix-org/gomatrixserverlib"
-)
-
-type RoomVersionID int
-type EventFormatID int
-
-const (
-	RoomVersionV1 RoomVersionID = iota + 1
-	RoomVersionV2
-	RoomVersionV3
-	RoomVersionV4
-	RoomVersionV5
-)
-
-const (
-	EventFormatV1 EventFormatID = iota + 1 // original event ID formatting
-	EventFormatV2                          // event ID is event hash
-	EventFormatV3                          // event ID is URL-safe base64 event hash
 )
 
+// RoomVersionDescription contains information about a room version,
+// namely whether it is marked as supported or stable in this server
+// version.
 type RoomVersionDescription struct {
-	Supported                 bool
+	Supported bool
-	Stable                    bool
+	Stable    bool
-	StateResolution           state.StateResolutionVersion
-	EventFormat               EventFormatID
-	EnforceSigningKeyValidity bool
 }
 
-var roomVersions = map[RoomVersionID]RoomVersionDescription{
+var roomVersions = map[gomatrixserverlib.RoomVersion]RoomVersionDescription{
-	RoomVersionV1: RoomVersionDescription{
+	gomatrixserverlib.RoomVersionV1: RoomVersionDescription{
-		Supported:                 true,
+		Supported: true,
-		Stable:                    true,
+		Stable:    true,
-		StateResolution:           state.StateResolutionAlgorithmV1,
-		EventFormat:               EventFormatV1,
-		EnforceSigningKeyValidity: false,
 	},
-	RoomVersionV2: RoomVersionDescription{
+	gomatrixserverlib.RoomVersionV2: RoomVersionDescription{
-		Supported:                 false,
+		Supported: false,
-		Stable:                    true,
+		Stable:    false,
-		StateResolution:           state.StateResolutionAlgorithmV2,
-		EventFormat:               EventFormatV1,
-		EnforceSigningKeyValidity: false,
 	},
-	RoomVersionV3: RoomVersionDescription{
+	gomatrixserverlib.RoomVersionV3: RoomVersionDescription{
-		Supported:                 false,
+		Supported: false,
-		Stable:                    true,
+		Stable:    false,
-		StateResolution:           state.StateResolutionAlgorithmV2,
-		EventFormat:               EventFormatV2,
-		EnforceSigningKeyValidity: false,
 	},
-	RoomVersionV4: RoomVersionDescription{
+	gomatrixserverlib.RoomVersionV4: RoomVersionDescription{
-		Supported:                 false,
+		Supported: false,
-		Stable:                    true,
+		Stable:    false,
-		StateResolution:           state.StateResolutionAlgorithmV2,
-		EventFormat:               EventFormatV3,
-		EnforceSigningKeyValidity: false,
 	},
-	RoomVersionV5: RoomVersionDescription{
+	gomatrixserverlib.RoomVersionV5: RoomVersionDescription{
-		Supported:                 false,
+		Supported: false,
-		Stable:                    true,
+		Stable:    false,
-		StateResolution:           state.StateResolutionAlgorithmV2,
-		EventFormat:               EventFormatV3,
-		EnforceSigningKeyValidity: true,
 	},
 }
 
-func GetDefaultRoomVersion() RoomVersionID {
+// GetDefaultRoomVersion contains the room version that will, by
-	return RoomVersionV1
+// default, be used to create new rooms on this server.
+func GetDefaultRoomVersion() gomatrixserverlib.RoomVersion {
+	return gomatrixserverlib.RoomVersionV1
 }
 
-func GetRoomVersions() map[RoomVersionID]RoomVersionDescription {
+// GetRoomVersions returns a map of all known room versions to this
+// server.
+func GetRoomVersions() map[gomatrixserverlib.RoomVersion]RoomVersionDescription {
 	return roomVersions
 }
 
-func GetSupportedRoomVersions() map[RoomVersionID]RoomVersionDescription {
+// GetSupportedRoomVersions returns a map of descriptions for room
-	versions := make(map[RoomVersionID]RoomVersionDescription)
+// versions that are supported by this homeserver.
+func GetSupportedRoomVersions() map[gomatrixserverlib.RoomVersion]RoomVersionDescription {
+	versions := make(map[gomatrixserverlib.RoomVersion]RoomVersionDescription)
 	for id, version := range GetRoomVersions() {
 		if version.Supported {
 			versions[id] = version
@@ -101,12 +75,46 @@ func GetSupportedRoomVersions() map[RoomVersionID]RoomVersionDescription {
 	return versions
 }
 
-func GetSupportedRoomVersion(version RoomVersionID) (desc RoomVersionDescription, err error) {
+// GetRoomVersion returns information about a specific room version.
+// An UnknownVersionError is returned if the version is not known
+// to the server.
+func GetRoomVersion(version gomatrixserverlib.RoomVersion) (RoomVersionDescription, error) {
 	if version, ok := roomVersions[version]; ok {
-		desc = version
+		return version, nil
 	}
-	if !desc.Supported {
+	return RoomVersionDescription{}, UnknownVersionError{version}
-		err = errors.New("unsupported room version")
+}
-	}
+
-	return
+// GetSupportedRoomVersion returns information about a specific room
+// version. An UnknownVersionError is returned if the version is not
+// known to the server, or an UnsupportedVersionError is returned if
+// the version is known but specifically marked as unsupported.
+func GetSupportedRoomVersion(version gomatrixserverlib.RoomVersion) (RoomVersionDescription, error) {
+	result, err := GetRoomVersion(version)
+	if err != nil {
+		return RoomVersionDescription{}, err
+	}
+	if !result.Supported {
+		return RoomVersionDescription{}, UnsupportedVersionError{version}
+	}
+	return result, nil
+}
+
+// UnknownVersionError is caused when the room version is not known.
+type UnknownVersionError struct {
+	Version gomatrixserverlib.RoomVersion
+}
+
+func (e UnknownVersionError) Error() string {
+	return fmt.Sprintf("room version '%s' is not known", e.Version)
+}
+
+// UnsupportedVersionError is caused when the room version is specifically
+// marked as unsupported.
+type UnsupportedVersionError struct {
+	Version gomatrixserverlib.RoomVersion
+}
+
+func (e UnsupportedVersionError) Error() string {
+	return fmt.Sprintf("room version '%s' is marked as unsupported", e.Version)
 }