Ask to refresh timeline when historical messages are imported (MSC2716)

cypress/plugins/synapsedocker/templates/COPYME/homeserver.yaml

@@ -12,7 +12,7 @@ listeners:
     x_forwarded: true
 
     resources:
-      - names: [client, federation, consent]
+      - names: [client, federation]
         compress: false
 
 # An sqlite in-memory database is fast & automatically wipes each time

cypress/plugins/synapsedocker/templates/msc2716-historical-import/README.md

@@ -0,0 +1 @@
+Start Synapse with `msc2716_enabled` and an application service configured

cypress/plugins/synapsedocker/templates/msc2716-historical-import/as-registration.yaml

@@ -0,0 +1,16 @@
+id: my_application_service_id
+hs_token: hs_token123
+as_token: as_token123
+url: 'http://localhost:0000'
+sender_localpart: gitter-badger
+namespaces:
+  users:
+    - exclusive: false
+      regex: .*
+  aliases:
+    - exclusive: false
+      regex: .*
+  rooms:
+    - exclusive: false
+      regex: .*
+rate_limited: false

cypress/plugins/synapsedocker/templates/msc2716-historical-import/homeserver.yaml

@@ -0,0 +1,80 @@
+server_name: "localhost"
+pid_file: /data/homeserver.pid
+# XXX: This won't actually be right: it lets docker allocate an ephemeral port,
+# so we have a chicken-and-egg problem
+public_baseurl: "{{PUBLIC_BASEURL}}"
+# Listener is always port 8008 (configured in the container)
+listeners:
+  - port: 8008
+    tls: false
+    bind_addresses: ['::']
+    type: http
+    x_forwarded: true
+
+    resources:
+      - names: [client, federation]
+        compress: false
+
+# An sqlite in-memory database is fast & automatically wipes each time
+database:
+  name: "sqlite3"
+  args:
+    database: ":memory:"
+
+# Needs to be configured to log to the console like a good docker process
+log_config: "/data/log.config"
+
+rc_messages_per_second: 10000
+rc_message_burst_count: 10000
+rc_registration:
+ per_second: 10000
+ burst_count: 10000
+
+rc_login:
+  address:
+    per_second: 10000
+    burst_count: 10000
+  account:
+    per_second: 10000
+    burst_count: 10000
+  failed_attempts:
+    per_second: 10000
+    burst_count: 10000
+
+media_store_path: "/data/media_store"
+uploads_path: "/data/uploads"
+enable_registration: true
+enable_registration_without_verification: true
+disable_msisdn_registration: false
+# These placeholders will be be replaced with values generated at start
+registration_shared_secret: "{{REGISTRATION_SECRET}}"
+report_stats: false
+macaroon_secret_key: "{{MACAROON_SECRET_KEY}}"
+form_secret: "{{FORM_SECRET}}"
+# Signing key must be here: it will be generated to this file
+signing_key_path: "/data/localhost.signing.key"
+email:
+   enable_notifs: false
+   smtp_host: "localhost"
+   smtp_port: 25
+   smtp_user: "exampleusername"
+   smtp_pass: "examplepassword"
+   require_transport_security: False
+   notif_from: "Your Friendly %(app)s homeserver <[email protected]>"
+   app_name: Matrix
+   notif_template_html: notif_mail.html
+   notif_template_text: notif_mail.txt
+   notif_for_new_users: True
+   client_base_url: "http://localhost/element"
+
+trusted_key_servers:
+  - server_name: "matrix.org"
+suppress_key_server_warning: true
+
+# A list of application service config files to use
+#
+app_service_config_files:
+  - /data/as-registration.yaml
+
+experimental_features:
+  msc2716_enabled: true

cypress/plugins/synapsedocker/templates/msc2716-historical-import/log.config

@@ -0,0 +1,50 @@
+# Log configuration for Synapse.
+#
+# This is a YAML file containing a standard Python logging configuration
+# dictionary. See [1] for details on the valid settings.
+#
+# Synapse also supports structured logging for machine readable logs which can
+# be ingested by ELK stacks. See [2] for details.
+#
+# [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
+# [2]: https://matrix-org.github.io/synapse/latest/structured_logging.html
+
+version: 1
+
+formatters:
+    precise:
+        format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s'
+
+handlers:
+    # A handler that writes logs to stderr. Unused by default, but can be used
+    # instead of "buffer" and "file" in the logger handlers.
+    console:
+        class: logging.StreamHandler
+        formatter: precise
+
+loggers:
+    synapse.storage.SQL:
+        # beware: increasing this to DEBUG will make synapse log sensitive
+        # information such as access tokens.
+        level: INFO
+
+    twisted:
+        # We send the twisted logging directly to the file handler,
+        # to work around https://github.com/matrix-org/synapse/issues/3471
+        # when using "buffer" logger. Use "console" to log to stderr instead.
+        handlers: [console]
+        propagate: false
+
+root:
+    level: INFO
+
+    # Write logs to the `buffer` handler, which will buffer them together in memory,
+    # then write them to a file.
+    #
+    # Replace "buffer" with "console" to log to stderr instead. (Note that you'll
+    # also need to update the configuration for the `twisted` logger above, in
+    # this case.)
+    #
+    handlers: [console]
+
+disable_existing_loggers: false

cypress/support/bot.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import type { ISendEventResponse, MatrixClient, Room } from "matrix-js-sdk/src/matrix";
+import type { ISendEventResponse, MatrixClient, Room, IMatrixClientCreateOpts } from "matrix-js-sdk/src/matrix";
 import { SynapseInstance } from "../plugins/synapsedocker";
 import Chainable = Cypress.Chainable;
 
@@ -50,6 +50,14 @@ declare global {
              * @param opts create bot options
              */
             getBot(synapse: SynapseInstance, opts: CreateBotOpts): Chainable<MatrixClient>;
+            /**
+             * Create a new Matrix client to interact with the API as user
+             * separate from the one logged in
+             * @param synapse the instance on which to register the bot user
+             * @param opts Options to pass when creating a new Matrix client
+             *     like `userId` and `accessToken`
+             */
+            newMatrixClient(synapse: SynapseInstance, opts: IMatrixClientCreateOpts): Chainable<MatrixClient>;
             /**
              * Let a bot join a room
              * @param cli The bot's MatrixClient
@@ -73,6 +81,21 @@ declare global {
     }
 }
 
+Cypress.Commands.add("newMatrixClient", (
+    synapse: SynapseInstance,
+    opts: IMatrixClientCreateOpts,
+): Chainable<MatrixClient> => {
+    return cy.window({ log: false }).then(win => {
+        const cli = new win.matrixcs.MatrixClient({
+            ...opts,
+        });
+
+        cli.startClient();
+
+        return cli;
+    });
+});
+
 Cypress.Commands.add("getBot", (synapse: SynapseInstance, opts: CreateBotOpts): Chainable<MatrixClient> => {
     opts = Object.assign({}, defaultCreateBotOptions, opts);
     const username = Cypress._.uniqueId("userId_");

cypress/support/client.ts

@@ -20,6 +20,7 @@ import type { FileType, Upload, UploadOpts } from "matrix-js-sdk/src/http-api";
 import type { ICreateRoomOpts, ISendEventResponse } from "matrix-js-sdk/src/@types/requests";
 import type { MatrixClient } from "matrix-js-sdk/src/client";
 import type { Room } from "matrix-js-sdk/src/models/room";
+import type { IJoinRoomOpts } from "matrix-js-sdk/src/@types/requests";
 import type { IContent } from "matrix-js-sdk/src/models/event";
 import Chainable = Cypress.Chainable;
 
@@ -49,6 +50,17 @@ declare global {
              * @param userId the id of the user to invite
              */
             inviteUser(roomId: string, userId: string): Chainable<{}>;
+            /**
+             * Joins the current user to the given room.
+             * @param roomIdOrAlias the id or alias of the room to join
+             * @param opts the options when joining a room
+             */
+            joinRoom(roomIdOrAlias: string, opts?: IJoinRoomOpts): Chainable<{}>;
+            /**
+             * Waits for the given room to be synced locally
+             * @param roomId the id of the room to wait for locally
+             */
+            waitForRoom(roomId: string): Chainable<string>;
             /**
              * Sets account data for the user.
              * @param type The type of account data.
@@ -123,11 +135,6 @@ declare global {
              * Boostraps cross-signing.
              */
             bootstrapCrossSigning(): Chainable<void>;
-            /**
-             * Joins the given room by alias or ID
-             * @param roomIdOrAlias the id or alias of the room to join
-             */
-            joinRoom(roomIdOrAlias: string): Chainable<Room>;
         }
     }
 }
@@ -143,11 +150,40 @@ Cypress.Commands.add("getDmRooms", (userId: string): Chainable<string[]> => {
 });
 
 Cypress.Commands.add("createRoom", (options: ICreateRoomOpts): Chainable<string> => {
+    cy.window({ log: false })
+        .then(async win => {
+            const cli = win.mxMatrixClientPeg.matrixClient;
+            const resp = await cli.createRoom(options);
+            const roomId = resp.room_id;
+            return roomId;
+        })
+        .as('roomId');
+
+    return cy.get<string>("@roomId").then(roomId => {
+        return cy.waitForRoom(roomId);
+    });
+});
+
+Cypress.Commands.add("inviteUser", (roomId: string, userId: string): Chainable<{}> => {
+    return cy.getClient().then(async (cli: MatrixClient) => {
+        return cli.invite(roomId, userId);
+    });
+});
+
+Cypress.Commands.add("joinRoom", (roomIdOrAlias: string, opts?: IJoinRoomOpts): Chainable<{}> => {
+    cy.getClient().then(async (cli: MatrixClient) => {
+        return cli.joinRoom(roomIdOrAlias, opts);
+    });
+
+    // Wait for the room to be available locally
+    return cy.waitForRoom(roomIdOrAlias);
+});
+
+Cypress.Commands.add("waitForRoom", (roomId: string): Chainable<string> => {
     return cy.window({ log: false }).then(async win => {
         const cli = win.mxMatrixClientPeg.matrixClient;
-        const resp = await cli.createRoom(options);
-        const roomId = resp.room_id;
 
+        // Wait for the room to be available locally
         if (!cli.getRoom(roomId)) {
             await new Promise<void>(resolve => {
                 const onRoom = (room: Room) => {
@@ -221,7 +257,3 @@ Cypress.Commands.add("bootstrapCrossSigning", () => {
         });
     });
 });
-
-Cypress.Commands.add("joinRoom", (roomIdOrAlias: string): Chainable<Room> => {
-    return cy.getClient().then(cli => cli.joinRoom(roomIdOrAlias));
-});

res/css/structures/_RoomStatusBar.pcss

@@ -76,6 +76,8 @@ limitations under the License.
         min-height: 70px;
         margin: 12px;
         padding-left: 16px;
+        padding-top: $spacing-4;
+        padding-bottom: $spacing-4;
         background-color: $header-panel-bg-color;
         border-radius: 4px;
     }
@@ -145,6 +147,12 @@ limitations under the License.
                     mask-image: url('$(res)/img/element-icons/retry.svg');
                 }
             }
+
+            &.mx_RoomStatusBar_refreshTimelineBtn {
+                &::before {
+                    mask-image: url('$(res)/img/element-icons/retry.svg');
+                }
+            }
         }
 
         .mx_InlineSpinner {

res/css/structures/_RoomView.pcss

@@ -130,7 +130,7 @@ limitations under the License.
 }
 
 .mx_RoomView_statusArea_expanded {
-    max-height: 100px;
+    max-height: 140px;
 }
 
 .mx_RoomView_statusAreaBox {

src/components/structures/FilePanel.tsx

@@ -104,7 +104,9 @@ class FilePanel extends React.Component<IProps, IState> {
         }
 
         if (!this.state.timelineSet.eventIdToTimeline(ev.getId())) {
-            this.state.timelineSet.addEventToTimeline(ev, timeline, false);
+            this.state.timelineSet.addEventToTimeline(ev, timeline, {
+                toStartOfTimeline: false,
+            });
         }
     }
 

src/components/structures/LoggedInView.tsx

@@ -351,8 +351,8 @@ class LoggedInView extends React.Component<IProps, IState> {
 
             const pinnedEventIds = pinStateEvent.getContent().pinned.slice(0, MAX_PINNED_NOTICES_PER_ROOM);
             for (const eventId of pinnedEventIds) {
-                const timeline = await this._matrixClient.getEventTimeline(room.getUnfilteredTimelineSet(), eventId);
-                const event = timeline.getEvents().find(ev => ev.getId() === eventId);
+                await this._matrixClient.getEventTimeline(room.getUnfilteredTimelineSet(), eventId);
+                const event = room.findEventById(eventId);
                 if (event) events.push(event);
             }
         }

src/components/structures/MessagePanel.tsx

@@ -144,7 +144,7 @@ interface IProps {
 
     // the userid of our user. This is used to suppress the read marker
     // for pending messages.
-    ourUserId?: string;
+    ourUserId?: string | null | undefined;
 
     // whether the timeline can visually go back any further
     canBackPaginate?: boolean;
@@ -158,7 +158,7 @@ interface IProps {
     stickyBottom?: boolean;
 
     // className for the panel
-    className: string;
+    className?: string;
 
     // show twelve hour timestamps
     isTwelveHour?: boolean;
@@ -172,7 +172,7 @@ interface IProps {
     // which layout to use
     layout?: Layout;
 
-    resizeNotifier: ResizeNotifier;
+    resizeNotifier?: ResizeNotifier;
     permalinkCreator?: RoomPermalinkCreator;
     editState?: EditorStateTransfer;