Base support for MSC3840: Ignore invites #2483

Yoric · 2022-07-01T14:21:51Z

This PR expects that most of the work will be done at higher level,
where the user can decide to look at a list of ignored invites,
un-ignore them individually, etc.

MSC: matrix-org/matrix-spec-proposals#3840

Here's what your changelog entry will look like:

✨ Features

Base support for MSC3840: Ignore invites (#2483). Contributed by @Yoric.

This PR expects that most of the work will be done at higher level, where the user can decide to look at a list of ignored invites, un-ignore them individually, etc. Signed-off-by: David Teller <davidt@element.io>

src/client.ts

turt2live

overall lgtm, though needs tests :)

Yoric · 2022-07-06T11:39:31Z

Adding a few unit tests.
I'm not convinced that they're testing anything useful, unfortunately.

jesopo · 2022-07-07T13:15:30Z

src/client.ts

+     * Gets the list of currently ignored invites.
+     */
+    public getIgnoredInvites(): IgnoredInvites {
+        const event = this.getAccountData(EventType.IgnoredInvites);


what's the computational complexity of this function call?

I haven't been able to find exactly where this is implemented. However, as far as I understand, this.getAccountData should be fast (because everything is cached to memory).

Also note that you can subscribe to client.on(ClientEvent.AccountData, event => { ... }) to be informed whenever a piece of account data changes.

Yoric/ignore invites update

jesopo

for what we're currently aiming to do, this looks correct to me

turt2live

generally this seems fine - thanks for adding the test, and apologies for missing some things in my last review.

turt2live · 2022-07-08T22:49:23Z

spec/unit/matrix-client.spec.ts

@@ -1297,4 +1297,37 @@ describe("MatrixClient", function() {
            expect(result!.aliases).toEqual(response.aliases);
        });
    });
+
+    describe("ignoring invites", () => {
+        it('stores ignored invites', async function() {


we should be using should, and arrow functions:

Suggested change

it('stores ignored invites', async function() {

it('should store ignored invites', async () => {

turt2live · 2022-07-08T22:49:35Z

spec/unit/matrix-client.spec.ts

+        it('stores ignored invites', async function() {
+            // Mockup account data storage.
+            const dataStore = new Map();
+            client.setAccountData = function(eventType, content) {


Suggested change

client.setAccountData = function(eventType, content) {

client.setAccountData = (eventType, content) => {

turt2live · 2022-07-08T22:49:43Z

spec/unit/matrix-client.spec.ts

+                dataStore.set(eventType, content);
+                return Promise.resolve();
+            };
+            client.getAccountData = function(eventType) {


Suggested change

client.getAccountData = function(eventType) {

client.getAccountData = (eventType) => {

turt2live · 2022-07-08T22:50:12Z

spec/unit/matrix-client.spec.ts

+            };
+
+            // Initially, the invite list should be empty but not `null`.
+            expect(await client.getIgnoredInvites()).toEqual({});


Suggested change

expect(await client.getIgnoredInvites()).toEqual({});

expect(await client.getIgnoredInvites()).toStrictEqual({});

turt2live · 2022-07-08T22:51:16Z

src/@types/event.ts

@@ -81,6 +81,7 @@ export enum EventType {
    PushRules = "m.push_rules",
    Direct = "m.direct",
    IgnoredUserList = "m.ignored_user_list",
+    IgnoredInvites = "org.matrix.msc3840.ignored_invites",


we're not supposed to define unstable event types here - we should be using UnstableValue().name

src/client.ts

turt2live · 2022-07-08T22:54:06Z

src/client.ts

+     * The instant the user decided to ignore this invite,
+     * as a Matrix timestamp.


Suggested change

* The instant the user decided to ignore this invite,

* as a Matrix timestamp.

* The timestamp for when the user decided to ignore this invite.

turt2live · 2022-07-08T22:54:48Z

src/client.ts

+}
+
+/**
+ * Invites to ignore across all devices/sessions, as per MSC 3840.


Suggested change

* Invites to ignore across all devices/sessions, as per MSC 3840.

* Invites to ignore across all devices/sessions, as per MSC3840.

*

* See https://github.com/matrix-org/matrix-spec-proposals/pull/3840

turt2live · 2022-07-08T22:55:19Z

src/client.ts

+ * This interface is expected to gain additional fields, all
+ * of them optional.
+ */
+export interface IgnoreInviteMetadata {


All of these interfaces will need a jsdoc line that says they can be removed at any point without notice due to being unstable.

turt2live · 2022-07-08T22:55:37Z

src/client.ts

+ */
+export interface IgnoredInvites {
+    /**
+     * A map of room ids => metadata for rooms the user does not wish to be invited to.


Suggested change

* A map of room ids => metadata for rooms the user does not wish to be invited to.

* A map of room IDs => metadata for rooms the user does not wish to be invited to.

Yoric · 2022-08-30T13:41:36Z

Closing in favour of another implementation based on MSC3847.

Base support for MSC3840: Ignore invites

a35d962

This PR expects that most of the work will be done at higher level, where the user can decide to look at a list of ignored invites, un-ignore them individually, etc. Signed-off-by: David Teller <davidt@element.io>

Yoric requested a review from a team as a code owner July 1, 2022 14:21

Yoric requested review from andybalaam, t3chguy and justjanne July 1, 2022 14:21

Yoric added 2 commits July 1, 2022 17:09

WIP: Linting

73fdb36

WIP: Fixes

78a7317

Gnuxie reviewed Jul 4, 2022

View reviewed changes

src/client.ts Outdated Show resolved Hide resolved

Gnuxie mentioned this pull request Jul 4, 2022

slash command to update ignored rooms list matrix-org/matrix-react-sdk#8983

Closed

turt2live reviewed Jul 4, 2022

View reviewed changes

turt2live removed request for andybalaam, t3chguy and justjanne July 4, 2022 19:02

turt2live added the T-Enhancement label Jul 4, 2022

Yoric added 2 commits July 6, 2022 13:38

WIP: Moving event key to EventType

0c1b39c

WIP: Adding some tests

608e87b

Yoric added 2 commits July 6, 2022 13:44

WIP: Coverage?

eee42b2

WIP: Linter

1564ad7

jesopo mentioned this pull request Jul 6, 2022

don't consider room invites that are ignored to be "visible" #2496

Draft

Yoric added 2 commits July 7, 2022 09:16

WIP: Applying feedback

200f3a1

WIP: Lint

96516bc

Yoric requested a review from turt2live July 7, 2022 07:39

jesopo reviewed Jul 7, 2022

View reviewed changes

Yoric added 6 commits July 7, 2022 18:21

WIP: Following feedback on MSC3840

7143515

Update client.ts

7546df8

WIP: Everything should now be in maps and properly readonly

8955612

Merge pull request #1 from Yoric/yoric/ignore-invites-update

de90f89

Yoric/ignore invites update

WIP: Linter

188d123

WIP: Linters

6b84eb0

jesopo approved these changes Jul 8, 2022

View reviewed changes

turt2live requested changes Jul 8, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Base support for MSC3840: Ignore invites #2483

Base support for MSC3840: Ignore invites #2483

Yoric commented Jul 1, 2022 •

edited by github-actions bot

Loading

turt2live left a comment

Yoric commented Jul 6, 2022

jesopo Jul 7, 2022

Yoric Jul 7, 2022

jesopo left a comment

turt2live left a comment

turt2live Jul 8, 2022

turt2live Jul 8, 2022

turt2live Jul 8, 2022

turt2live Jul 8, 2022

turt2live Jul 8, 2022

turt2live Jul 8, 2022

turt2live Jul 8, 2022

turt2live Jul 8, 2022

turt2live Jul 8, 2022

Yoric commented Aug 30, 2022

	it('stores ignored invites', async function() {
	it('should store ignored invites', async () => {

	client.setAccountData = function(eventType, content) {
	client.setAccountData = (eventType, content) => {

	client.getAccountData = function(eventType) {
	client.getAccountData = (eventType) => {

	expect(await client.getIgnoredInvites()).toEqual({});
	expect(await client.getIgnoredInvites()).toStrictEqual({});

		* The instant the user decided to ignore this invite,
		* as a Matrix timestamp.

	* The instant the user decided to ignore this invite,
	* as a Matrix timestamp.
	* The timestamp for when the user decided to ignore this invite.

- * Invites to ignore across all devices/sessions, as per MSC 3840.
+ * Invites to ignore across all devices/sessions, as per MSC3840.
+ *
+ * See https://github.com/matrix-org/matrix-spec-proposals/pull/3840

	* A map of room ids => metadata for rooms the user does not wish to be invited to.
	* A map of room IDs => metadata for rooms the user does not wish to be invited to.

Base support for MSC3840: Ignore invites #2483

Base support for MSC3840: Ignore invites #2483

Conversation

Yoric commented Jul 1, 2022 • edited by github-actions bot Loading

✨ Features

turt2live left a comment

Choose a reason for hiding this comment

Yoric commented Jul 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jesopo left a comment

Choose a reason for hiding this comment

turt2live left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yoric commented Aug 30, 2022

Yoric commented Jul 1, 2022 •

edited by github-actions bot

Loading