-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Make e2e backup versions numeric in the DB #4113
Changes from 7 commits
563f9b6
64fa557
4eacf0f
2f0f911
12941f5
e0934ac
d3fa619
4f93abd
d44dea0
bca3b91
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Fix e2e key backup with more than 9 backup versions |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,7 +25,7 @@ | |
|
||
# Remember to update this number every time a change is made to database | ||
# schema files, so the users will be informed on server restarts. | ||
SCHEMA_VERSION = 51 | ||
SCHEMA_VERSION = 52 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. someone (@erikjohnston ?) remind me what our policy is for when we have to bump this? is it written down somewhere? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My reason for bumping it here is that the original e2e room keys tables were added in 51 and this changes obviously needs to happen after that. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. well, that seems a good reason. Another good reason is that we are already up to 52 in develop; I'm not sure why it is being shown as a change here. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ah, probably because I branched off before that |
||
|
||
dir_path = os.path.abspath(os.path.dirname(__file__)) | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
/* Copyright 2018 New Vector 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. | ||
*/ | ||
|
||
/* Change version column to an integer so we can do MAX() sensibly | ||
*/ | ||
CREATE TABLE e2e_room_keys_versions_new ( | ||
user_id TEXT NOT NULL, | ||
version BIGINT NOT NULL, | ||
algorithm TEXT NOT NULL, | ||
auth_data TEXT NOT NULL, | ||
deleted SMALLINT DEFAULT 0 NOT NULL | ||
); | ||
|
||
INSERT INTO e2e_room_keys_versions_new | ||
SELECT user_id, CAST(version as BIGINT), algorithm, auth_data, deleted FROM e2e_room_keys_versions; | ||
|
||
DROP TABLE e2e_room_keys_versions; | ||
ALTER TABLE e2e_room_keys_versions_new RENAME TO e2e_room_keys_versions; | ||
|
||
CREATE UNIQUE INDEX e2e_room_keys_versions_idx ON e2e_room_keys_versions(user_id, version); | ||
|
||
/* Change e2e_rooms_keys to match | ||
*/ | ||
CREATE TABLE e2e_room_keys_new ( | ||
user_id TEXT NOT NULL, | ||
room_id TEXT NOT NULL, | ||
session_id TEXT NOT NULL, | ||
version BIGINT NOT NULL, | ||
first_message_index INT, | ||
forwarded_count INT, | ||
is_verified BOOLEAN, | ||
session_data TEXT NOT NULL | ||
); | ||
|
||
INSERT INTO e2e_room_keys_new | ||
SELECT user_id, room_id, session_id, CAST(version as BIGINT), first_message_index, forwarded_count, is_verified, session_data FROM e2e_room_keys; | ||
|
||
DROP TABLE e2e_room_keys; | ||
ALTER TABLE e2e_room_keys_new RENAME TO e2e_room_keys; | ||
|
||
CREATE UNIQUE INDEX e2e_room_keys_idx ON e2e_room_keys(user_id, room_id, session_id); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we not just keep this as an int?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a string in the API, ie. when json encoded for the client it needs to be
"2"
rather than2
, so we need to stringify it at some point. I don't really mind whether we model them as int throughout the whole of synapse & convert to str at the last minute for marshalling or just keep them as ints at the database layer.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason to then not have them as strings in the database layer?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It currently does a MAX() at the db layer to get the largest version, then increments it in python, which breaks when the column type is a string because "10" < "2" which is the bug this fixes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why does the API have it as a string when JSON has numbers?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#e2e-dev:matrix.org has the API / spec discussion: this one was: https://matrix.to/#/!uewiilduiDRfPomIha:matrix.org/$15397878202555374QpBig:matrix.org