Implement MSC4133 to support custom profile fields. #17488

clokep · 2024-07-25T20:22:44Z

Implementation of MSC4133 to support custom profile fields. It is behind an experimental flag and includes tests.

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file. The entry should:
- Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
- Use markdown where necessary, mostly for code blocks.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
Code style is correct
(run the linters)

anoadragon453

A few comments, but this is definitely on the right track. Thanks for implementing this!

synapse/handlers/profile.py

synapse/handlers/sso.py

synapse/rest/client/profile.py

synapse/storage/databases/main/profile.py

synapse/storage/schema/main/delta/86/01_custom_profile_fields.sql

tests/rest/client/test_profile.py

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

… custom-fields

clokep · 2024-08-09T20:09:26Z

I pushed some changes to update / flesh out the rest of the MSC, but I haven't yet gone through @anoadragon453's comments so not worth another review yet. (If folks want to test it that would be reasonable...I'm sure it'll break.)

synapse/config/experimental.py

synapse/handlers/profile.py

synapse/rest/client/profile.py

clokep · 2024-11-07T12:50:04Z

I think this is close to ready for another review. There's a few open questions on the MSC that will affect this still.

This is essentially matrix-org/synapse#14392. I didn't see anything in there about updating sytest or complement. The main driver of this is so that I can use `jsonb_path_exists` in #17488. 😄

… custom-fields

clokep · 2024-12-31T19:24:21Z

We're very excited to have this feature! What are the next steps?

Part of this was split to a separate PR as requested by the reviewer (Refactor get_profile: do not return missing fields. #18063).
After that I'll need to merge develop in, then this should be good for review.

Refactor `get_profile` to avoid returning "empty" (`None` / `null`) fields. Currently this is not very important, but will be more useful once #17488 lands. It does update the servlet to use this now which has a minor change in behavior: additional fields served over federation will now be properly sent back to clients. It also adds constants for `avatar_url` / `displayname` although I did not attempt to use it everywhere possible.

clokep · 2025-01-03T19:14:21Z

@anoadragon453 This should be ready for another review. The commits definitely became very messy so unfortunately probably needs to be reviewed as a single change.

anoadragon453

This looks great, thank you! ✨

Just a few minor points below, but nothing fundamental.

anoadragon453 · 2025-01-09T18:07:04Z

synapse/rest/client/capabilities.py

+        if self.config.experimental.msc4133_enabled:
+            response["capabilities"]["uk.tcpip.msc4133.profile_fields"] = {
+                "enabled": True,
+            }


MSC4133 states that when this field is missing, clients can assume that they are able to upload and modify custom profile fields. However, that won't work as the experimental feature is disabled.

Shouldn't we thus always be advertising this capability as false, to discourage clients on recent Synapse versions with the experimental feature disabled from trying to set custom profile fields? So:

Suggested change

if self.config.experimental.msc4133_enabled:

response["capabilities"]["uk.tcpip.msc4133.profile_fields"] = {

"enabled": True,

}

response["capabilities"]["uk.tcpip.msc4133.profile_fields"] = {

"enabled": self.config.experimental.msc4133_enabled,

}

anoadragon453 · 2025-01-09T18:24:11Z

synapse/storage/databases/main/profile.py

+            retcol="fields",
+            desc="get_profile_fields",
+        )
+        # The SQLite driver doesn't automatically convert JSON to


Suggested change

# The SQLite driver doesn't automatically convert JSON to

# The SQLite driver doesn't automatically convert JSON to

# Python objects

anoadragon453 · 2025-01-09T18:27:18Z

synapse/rest/client/profile.py

+        if not UserID.is_valid(user_id):
+            raise SynapseError(
+                HTTPStatus.BAD_REQUEST, "Invalid user id", Codes.INVALID_PARAM
+            )


Why did you choose to explicitly perform this check in the GET implementation, but not in the PUT or DELETE ones?

anoadragon453 · 2025-01-09T19:25:19Z

synapse/storage/databases/main/profile.py

+            # Discount the opening and closing braces to avoid double counting,
+            # but add one for a comma.


Just to make it explicit what value this comment is referring to.

Suggested change

# Discount the opening and closing braces to avoid double counting,

# but add one for a comma.

# Discount the opening and closing braces to avoid double counting,

# but add one for a comma.

# -2 + 1 = -1

anoadragon453 · 2025-01-09T19:32:49Z

synapse/storage/databases/main/profile.py

+
+    async def delete_profile_field(self, user_id: UserID, field_name: str) -> None:
+        """
+        Set a custom profile field for a user.


Suggested change

Set a custom profile field for a user.

Remove a custom profile field for a user.

anoadragon453 · 2025-01-09T19:35:55Z

synapse/handlers/profile.py

+            raise SynapseError(400, "User is not hosted on this homeserver")
+
+        if not by_admin and target_user != requester.user:
+            raise AuthError(400, "Cannot set another user's profile")


Looks like this should be a 403 according to the MSC.

Suggested change

raise AuthError(400, "Cannot set another user's profile")

raise AuthError(403, "Cannot set another user's profile")

anoadragon453 · 2025-01-09T19:37:09Z

synapse/handlers/profile.py

+        """Set a new avatar URL for a user.
+
+        Args:
+            target_user: the user whose avatar URL is to be changed.


Suggested change

"""Set a new avatar URL for a user.

Args:

target_user: the user whose avatar URL is to be changed.

"""Delete a field from a user's profile.

Args:

target_user: the user whose profile is to be changed.

anoadragon453 · 2025-01-09T19:37:20Z

synapse/handlers/profile.py

+        Args:
+            target_user: the user whose avatar URL is to be changed.
+            requester: The user attempting to make this change.
+            field_name: The name of the profile field to update.


Suggested change

field_name: The name of the profile field to update.

field_name: The name of the profile field to remove.

anoadragon453 · 2025-01-09T19:39:46Z

synapse/http/servlet.py

@@ -962,7 +962,7 @@ def register(self, http_server: HttpServer) -> None:
        """Register this servlet with the given HTTP server."""
        patterns = getattr(self, "PATTERNS", None)
        if patterns:
-            for method in ("GET", "PUT", "POST", "DELETE"):
+            for method in ("GET", "PUT", "POST", "DELETE", "PATCH"):


Why was this needed?

anoadragon453 · 2025-01-09T19:42:49Z

tests/rest/client/test_profile.py

+            content={"diff_key": "test"},
+            access_token=self.owner_tok,
+        )
+        self.assertEqual(channel.code, 400, channel.result)


Could you also check for the appropriate errcodes in this test?

clokep added 3 commits July 25, 2024 16:18

Implement MSC4133 to support custom profile fields.

e7ab5a1

Newsfragment

a80c0eb

Move delta.

dcacf35

clokep marked this pull request as ready for review July 26, 2024 00:00

clokep requested a review from a team as a code owner July 26, 2024 00:00

anoadragon453 requested changes Jul 31, 2024

View reviewed changes

clokep and others added 4 commits July 31, 2024 07:25

Copy & paste error.

60b3f00

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Clarify docstring.

d2ab9c9

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Correct license.

ce405ab

Fix typo.

e4f9d7e

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

tcpipuk mentioned this pull request Jul 31, 2024

Implement extended user profiles for MSC4133 (Done) girlbossceo/conduwuit#435

Closed

clokep added 5 commits August 9, 2024 16:00

Add more methods.

2c28bd5

Merge remote-tracking branch 'refs/remotes/origin/custom-fields' into…

00c02ac

… custom-fields

Merge remote-tracking branch 'upstream/develop' into custom-fields

f0e02aa

Add comment.

8030ba2

Get tests passing.

735e8cc

Review comments.

8d9b74e

clokep mentioned this pull request Aug 13, 2024

Add missing docstrings related to profile methods. #17559

Merged

3 tasks

clokep added 3 commits September 5, 2024 12:14

Merge remote-tracking branch 'upstream/develop' into custom-fields

3658b6a

Handle TODO about limiting overall size.

02b852a

Ensure fields exist.

00ad911

Half-Shot reviewed Sep 8, 2024

View reviewed changes

synapse/config/experimental.py Outdated Show resolved Hide resolved

Half-Shot reviewed Sep 8, 2024

View reviewed changes

synapse/handlers/profile.py Show resolved Hide resolved

Half-Shot reviewed Sep 8, 2024

View reviewed changes

synapse/handlers/profile.py Show resolved Hide resolved

Half-Shot reviewed Sep 9, 2024

View reviewed changes

synapse/rest/client/profile.py Show resolved Hide resolved

Fix-up capabilities.

87ff9f8

clokep changed the title ~~Partially implement MSC4133 to support custom profile fields.~~ Implement MSC4133 to support custom profile fields. Sep 9, 2024

clokep added 2 commits September 10, 2024 17:04

Add to /versions.

4b44da3

Merge remote-tracking branch 'upstream/develop' into custom-fields

cf7499a

clokep added 8 commits October 31, 2024 10:40

Updates from MSC.

52fe59f

Merge remote-tracking branch 'upstream/develop' into custom-fields

66878c4

Get postgres working again.

1c98d96

Working on sqlite again.

749e27d

Move schema delta again.

6936daf

Fix-up max length checks.

64fe222

Fix-up fetching individual fields.

6c777b2

Merge remote-tracking branch 'upstream/develop' into custom-fields

7cc1264

clokep added 4 commits November 14, 2024 16:25

Merge remote-tracking branch 'upstream/develop' into custom-fields

91a29e5

Merge remote-tracking branch 'upstream/develop' into custom-fields

4318bdd

Remove the PATCH endpoint.

11cc48a

Match the MSC error codes.

adb64d8

clokep mentioned this pull request Dec 16, 2024

Remove support for PostgreSQL 11 and 12 #18034

Merged

3 tasks

clokep and others added 4 commits December 19, 2024 15:42

Merge branch 'develop' into custom-fields

069d6f9

Remove PUT endpoint.

2a327bf

Merge remote-tracking branch 'refs/remotes/origin/custom-fields' into…

2357ae9

… custom-fields

Merge remote-tracking branch 'upstream/develop' into custom-fields

f176237

This comment was marked as off-topic.

Sign in to view

nexy7574 mentioned this pull request Dec 30, 2024

Add timezones and pronouns tulir/gomuks#574

Merged

clokep mentioned this pull request Dec 31, 2024

Refactor get_profile: do not return missing fields. #18063

Merged

3 tasks

Merge remote-tracking branch 'upstream/develop' into custom-fields

8fc0612

Merge remote-tracking branch 'upstream/develop' into custom-fields

d82bfcd

clokep requested a review from anoadragon453 January 3, 2025 19:13

Merge branch 'develop' into custom-fields

57bf948

anoadragon453 requested changes Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement MSC4133 to support custom profile fields. #17488

Implement MSC4133 to support custom profile fields. #17488

clokep commented Jul 25, 2024 •

edited

Loading

anoadragon453 left a comment

clokep commented Aug 9, 2024

clokep commented Nov 7, 2024

This comment was marked as off-topic.

clokep commented Dec 31, 2024

clokep commented Jan 3, 2025

anoadragon453 left a comment

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

anoadragon453 Jan 9, 2025

	# The SQLite driver doesn't automatically convert JSON to
	# The SQLite driver doesn't automatically convert JSON to
	# Python objects

		# Discount the opening and closing braces to avoid double counting,
		# but add one for a comma.

	Set a custom profile field for a user.
	Remove a custom profile field for a user.

	raise AuthError(400, "Cannot set another user's profile")
	raise AuthError(403, "Cannot set another user's profile")

	field_name: The name of the profile field to update.
	field_name: The name of the profile field to remove.

Implement MSC4133 to support custom profile fields. #17488

Are you sure you want to change the base?

Implement MSC4133 to support custom profile fields. #17488

Conversation

clokep commented Jul 25, 2024 • edited Loading

Pull Request Checklist

anoadragon453 left a comment

Choose a reason for hiding this comment

clokep commented Aug 9, 2024

clokep commented Nov 7, 2024

This comment was marked as off-topic.

clokep commented Dec 31, 2024

clokep commented Jan 3, 2025

anoadragon453 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

Choose a reason for hiding this comment

clokep commented Jul 25, 2024 •

edited

Loading