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 <[email protected]>

… 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-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.

synapse/rest/client/capabilities.py

synapse/storage/databases/main/profile.py

synapse/rest/client/profile.py

synapse/storage/databases/main/profile.py

synapse/handlers/profile.py

synapse/http/servlet.py

tests/rest/client/test_profile.py

Co-authored-by: Andrew Morgan <[email protected]>

anoadragon453

A few small things, but otherwise this looks nearly good to go!

synapse/util/stringutils.py

synapse/rest/client/profile.py

synapse/rest/client/capabilities.py

Co-authored-by: Andrew Morgan <[email protected]>

clokep · 2025-01-20T19:47:24Z

Good catch @anoadragon453! I've added a bunch more tests to ensure this is all working as expected. 👍 Should be ready for merge, hopefully!

anoadragon453

LGTM, thanks for being so proactive with this one!

clokep · 2025-01-21T15:00:44Z

Thanks for all the reviews!

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 9 commits July 31, 2024 07:25

Copy & paste error.

60b3f00

Co-authored-by: Andrew Morgan <[email protected]>

Clarify docstring.

d2ab9c9

Co-authored-by: Andrew Morgan <[email protected]>

Correct license.

ce405ab

Fix typo.

e4f9d7e

Co-authored-by: Andrew Morgan <[email protected]>

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 3 commits September 10, 2024 17:04

Add to /versions.

4b44da3

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

cf7499a

Rename delta.

d28bf25

nexy7574 mentioned this pull request Dec 30, 2024

Add timezones and pronouns gomuks/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

clokep and others added 5 commits January 10, 2025 13:59

Clarify comments & minor nits.

af3567a

Co-authored-by: Andrew Morgan <[email protected]>

Add more user_id checks.

d2262c2

Expand tests.

78ea34f

Fix-up disallowed capabilities

cfbdd8c

Add better grammar checking.

28421bc

clokep requested a review from anoadragon453 January 17, 2025 18:26

anoadragon453 requested changes Jan 20, 2025

View reviewed changes

synapse/util/stringutils.py Show resolved Hide resolved

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

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

synapse/rest/client/capabilities.py Outdated Show resolved Hide resolved

clokep and others added 4 commits January 20, 2025 14:43

Fix negation

48e5d19

Co-authored-by: Andrew Morgan <[email protected]>

Clarify errors.

bd23371

Co-authored-by: Andrew Morgan <[email protected]>

More tests

5e4a13b

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

c38f229

clokep requested a review from anoadragon453 January 20, 2025 19:46

anoadragon453 approved these changes Jan 21, 2025

View reviewed changes

anoadragon453 merged commit ca290d3 into element-hq:develop Jan 21, 2025
39 checks passed

clokep deleted the custom-fields branch January 23, 2025 01:27

efMss24 mentioned this pull request Mar 13, 2025

Additional arbitrary room information matrix-org/matrix-spec#2094

Closed

Periclod mentioned this pull request Jun 7, 2025

Add config to prevent changes to custom profile keys #18525

Open

MatMaul mentioned this pull request Jul 15, 2025

Ajouter un statut à son profil tchapgouv/tchap-product#431

Open

Implement MSC4133 to support custom profile fields. #17488

Implement MSC4133 to support custom profile fields. #17488

Uh oh!

Conversation

clokep commented Jul 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clokep commented Aug 9, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clokep commented Dec 31, 2024

Uh oh!

clokep commented Jan 3, 2025

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clokep commented Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

clokep commented Jan 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

clokep commented Jul 25, 2024 •

edited

Loading

clokep commented Jan 20, 2025 •

edited

Loading