Add bio fields #6645

Gargron · 2018-03-05T22:44:58Z

A feature that allows adding structured data to profiles. Based on @marrus-sh's implementation (could not find a glitch-soc PR for it though), except the fields are not part of the text.

Fix Add pronoun field alongside bio #3211
Fix bio options #232
Fix No URL in profile #121

Screenshots:

Display on public page
Return from REST API
Edit
Federate

How they are stored internally: As a JSONB column on the accounts table, which contains an array of { "name": "", "value": "" } objects. Why: Normally something like this would be implemented via a has_many association with separate database records for every field, but I do not want to add so many more eager loaded queries to everywhere, and the fields don't really need to be queried or updated standalone, so being nested in the account record seems okay.

How they are federated: Inside the actor's attachment tag they are represented as:

{
  "type": "PropertyValue",
  "name": "",
  "value": ""
}

Where PropertyValue and value come from the schema.org context, while name comes from the vanilla ActivityStreams context. The value can contain HTML, while the name cannot.

akihikodaki · 2018-03-08T06:34:39Z

I am not for this change.

A writer of the bio fields may be excited and appreciate that it allows markup like that, but I do not think such a markup will actually benefit readers. A colon-separated text or even a normal statements would work well.

Gargron · 2018-03-08T06:54:46Z

A writer of the bio fields may be excited and appreciate that it allows markup like that, but

No, this change does not plan for special markup, rather, edit profile form should have +/- field inputs.

akihikodaki · 2018-03-08T09:57:30Z

No, this change does not plan for special markup, rather, edit profile form should have +/- field inputs.

I meant the table is the special markup.

Gargron · 2018-04-11T10:30:57Z

@akihikodaki is normalizeAccount not run for the "me" account included with initialState in current master? i am trying to bring my "bio fields" PR up to date and running into this issue...

ThisIsMissEm · 2018-04-12T03:06:36Z

I was thinking of doing a similar PR, but making the fields configurable by the admins (perhaps "default fields") and then also adding the ability for "locked" fields, which require an admin or certain application to edit.

Our use case is a default field that adds a "verified" status, and that being managed by an application, such that you can't manually add this field, and you could then know with certainty that we have actually verified the user.

This is important as we have users that may meet in person (potentially more likely than in other mastodon instances).

akihikodaki · 2018-04-12T04:33:12Z

@Gargron

@akihikodaki is normalizeAccount not run for the "me" account included with initialState in current master? i am trying to bring my "bio fields" PR up to date and running into this issue...

I have just checked it and it looks fine for me. I added console.log:

diff --git a/app/javascript/mastodon/actions/importer/index.js b/app/javascript/mastodon/actions/importer/index.js
index 5b18cbc1d..907fe558d 100644
--- a/app/javascript/mastodon/actions/importer/index.js
+++ b/app/javascript/mastodon/actions/importer/index.js
@@ -45,6 +45,7 @@ export function importFetchedAccounts(accounts) {
   }
 
   accounts.forEach(processAccount);
+  console.log(normalAccounts);
   putAccounts(normalAccounts, !autoPlayGif);
 
   return importAccounts(normalAccounts);

And here is its output:

[{"id":"1","username":"admin","acct":"admin","display_name":"ねこ","locked":false,"created_at":"2018-04-05T12:02:21.752Z","note":"<p></p>","url":"http://localhost:3000/@admin","avatar":"http://localhost:3000/avatars/original/missing.png","avatar_static":"http://localhost:3000/avatars/original/missing.png","header":"http://localhost:3000/headers/original/missing.png","header_static":"http://localhost:3000/headers/original/missing.png","followers_count":1,"following_count":0,"statuses_count":9,"display_name_html":"ねこ","note_emojified":"<p></p>"}]

- Fix #3211 - Fix #232 - Fix #121

Gargron · 2018-04-12T18:28:07Z

@ThisIsMissEm I'm sorry but that won't work. A verified status like that should not federate, in my opinion, we should not teach users to trust anything like that that comes out of other servers. Besides, you don't even need something so complicated. Add a boolean column to the accounts table and put a checkmark on public profiles, somewhere where it can't be confused with any emoji.

ThisIsMissEm · 2018-04-12T18:51:56Z

@Gargron oh, hm. I hadn't really thought about that as a valid option — seemed like it'd cause a compatibility issue and be a bit too much of a fork. I'm still getting bearings as to managing the forked codebase and making sure we can still update to upstream.

Gargron · 2018-04-12T19:22:52Z

@ThisIsMissEm That's a really small change, I don't think you'll have problems with it.

Anyway, left todo in this PR: A UI on the "edit profile" page to edit these fields 😩

ThisIsMissEm · 2018-04-12T19:55:54Z

@Gargron for that, is it possible to use react components on the /admin or /settings pages? I'd be happy to do the UI for you if that's why you're leaving it as an open todo.

ThisIsMissEm · 2018-04-13T16:13:19Z

spec/services/activitypub/process_account_service_spec.rb

+      account = subject.call('alice', 'example.com', payload)
+      expect(account.fields).to be_a Hash
+      expect(account.fields).to include('name' => 'Pronouns', 'value' => 'They/them')
+      expect(account.fields).to include('name' => 'Occupation', 'value' => 'Unit test')


is it worth checking that account.fields doesn't have more than the payload declared?

Fix #121

Cassolotl · 2018-04-13T18:56:21Z

These screenshots look awesome! :)

kevinmarks · 2018-04-14T11:11:34Z

Regarding verification, see the http://www.kevinmarks.com/distributed-verify.html approach. Add rel=me to these links, and check that they link back with a rel=me as well. Then you can tell that the same person can edit both pages.

Gargron · 2018-04-14T11:23:58Z

@kevinmarks I did add rel=me, it's the last commit.

kevinmarks · 2018-04-14T11:27:44Z

Excellent, I'll give it a try when this gets deployed.

…

On Sat, 14 Apr 2018, 12:24 Eugen Rochko, ***@***.***> wrote: @kevinmarks <https://github.com/kevinmarks> I did add rel=me, it's the last commit. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6645 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAGCwG3Vkq5LYZJNnhWfFJOppSQkmIIlks5todxigaJpZM4SdzKY> .

Wolf480pl · 2018-04-14T12:10:41Z

Does it render to semantic HTML, eg. using a microformat like hCard?

Gargron · 2018-04-14T12:21:20Z

It's a th/td table. Is there hCard markup for arbitrary information fields?

Wolf480pl · 2018-04-14T12:34:32Z

It's a th/td table.

I'd probably go for dt/dd

Is there hCard markup for arbitrary information fields?

The whole idea of hCard is to tell the fields apart, eg. tag the email field as email, the nickname field as nickname, the birthday field as birthday, etc. Now that I think of it, it'd probably require some further UI to let the users optionally add hCard classes... sounds like a separate feature I guess?

kevinmarks · 2018-04-14T12:54:05Z

Arbitrary properties are allowed in h-card, but that might not be ideal. Worth putting u-url on url properties. Defined properties are http://microformats.org/wiki/h-card#Properties

…

On Sat, 14 Apr 2018, 13:34 Wolf480pl, ***@***.***> wrote: It's a th/td table. I'd probably go for dt/dd Is there hCard markup for arbitrary information fields? The whole idea of hCard is to tell the fields apart, eg. tag the email field as email, the nickname field as nickname, the birthday field as birthday, etc. Now that I think of it, it'd probably require some further UI to let the users optionally add hCard classes... sounds like a separate feature I guess? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6645 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAGCwNB7RzTkhCkHrfdWcrzE7vklIV8Eks5toezqgaJpZM4SdzKY> .

Gargron · 2018-04-14T17:04:08Z

The whole idea of hCard is to tell the fields apart, eg. tag the email field as email, the nickname field as nickname, the birthday field as birthday, etc

Well, I never said this was an hCard. The whole idea of this function is to let users define whatever they deem necessary on their profile. So while it could be something common like "homepage", it could also be "github" or "pronouns" or "avatar made by" or "favourite cake".

kevinmarks · 2018-04-14T17:06:36Z

You could use the h-card ones as autocomplete (they're based on vcard, which has had a lot of convergence research)

…

On Sat, 14 Apr 2018, 18:04 Eugen Rochko, ***@***.***> wrote: The whole idea of hCard is to tell the fields apart, eg. tag the email field as email, the nickname field as nickname, the birthday field as birthday, etc Well, I never said this was an hCard. The whole idea of *this* function is to let users define whatever they deem necessary on their profile. So while it could be something common like "homepage", it could also be "github" or "pronouns" or "avatar made by" or "favourite cake". — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6645 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAGCwPtTYtIZTmZwNlfXFQNSO2yExVmGks5toiwXgaJpZM4SdzKY> .

Gargron · 2018-04-14T17:21:21Z

I actually don't see the benefit of it at all. Do any everyday non-technical users care about being vcard-comforming? Do they want that data to be machine-readable? In my impression, they do not.

This reverts commit 78ed4ab.

This reverts commit 38ee172.

This reverts commit 627bf47.

* i18n: (zh-CN) #7532 * i18n: (zh-CN) #6984 * i18n: (zh-CN) #7391, #7507 * i18n: (zh-CN) #6998 * i18n: (zh-CN) #7074 * i18n: (zh-CN) #7000, #7032, #7131 (#7032, #7040) * i18n: (zh-CN) #7130, #7188 * i18n: (zh-CN) #6486 * i18n: (zh-CN) #6292 * i18n: (zh-CN) #7347 * i18n: (zh-CN) #6661 * i18n: (zh-CN) #6425 * i18n: (zh-CN) #6597 * i18n: (zh-CN) #6695 * i18n: (zh-CN) #6325 * i18n: (zh-CN) #6460, #7375 * i18n: (zh-CN) #6872 * i18n: (zh-CN) #6818 * i18n: (zh-CN) #7452 * i18n: (zh-CN) #7176 * i18n: (zh-CN) #6460 * i18n: (zh-CN) #7213 * i18n: (zh-CN) #7376 * i18n: (zh-CN) #6556 * i18n: (zh-CN) #6645 * i18n: (zh-CN) #6448 * i18n: (zh-CN) #5303 * i18n: (zh-CN) #7445 * i18n: (zh-CN) Normalization and improvements * i18n: (zh-CN) #7391 * i18n: (zh-CN) #6627 * i18n: (zh-CN) #6956, #7546 * i18n: (zh-CN) #6636 * i18n: (zh-CN) #6610, #6875 * i18n: (zh-CN) #6887 * i18n: (zh-CN) #4514 * i18n: (zh-CN) #6628 * i18n: (zh-CN) #6771 * i18n: (zh-CN) #6772 * i18n: (zh-CN) #7178 * i18n: (zh-CN) #7521 * i18n: (zh-CN) #6570 * i18n: (zh-CN) #6593 * i18n: (zh-CN) #6423 * i18n: (zh-CN) #6157 * i18n: (zh-CN) #7089 * i18n: (zh-CN) #6733 * i18n: (zh-CN) #7072 * i18n: (zh-CN) #6520 * i18n: (zh-CN) Improvment * i18n: (zh-CN) #6631

…Also"

saper · 2018-12-27T14:22:51Z

db/schema.rb

@@ -75,6 +75,7 @@
    t.boolean "memorial", default: false, null: false
    t.bigint "moved_to_account_id"
    t.string "featured_collection_url"
+    t.jsonb "fields"


If fields is JSONB shouldn't account.fields be a Hash and not an Array?

See report on https://discourse.joinmastodon.org/t/error-on-profile-edit-for-single-user-nomethoderror-undefined-method-for-hash/1563

nightpool · 2018-12-27T15:40:15Z

@saper no, because profile fields are sorted and json objects are arbitrary order

…

On Thu, Dec 27, 2018, 8:22 AM Marcin Cieślak ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In db/schema.rb <#6645 (comment)>: > @@ -75,6 +75,7 @@ t.boolean "memorial", default: false, null: false t.bigint "moved_to_account_id" t.string "featured_collection_url" + t.jsonb "fields" If fields is JSONB shouldn't be a Hash and not an Array? See report on https://discourse.joinmastodon.org/t/error-on-profile-edit-for-single-user-nomethoderror-undefined-method-for-hash/1563 — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#6645 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAORVxjdEx-uiiilDi9VG0EwJQhLYgnnks5u9Ne9gaJpZM4SdzKY> .

saper · 2018-12-27T20:11:31Z

@saper no, because profile fields are sorted and json objects are arbitrary order

Thanks. But it seems to me that JSONB storage will lose that ordering? Is this the correct serialization (or am I completely confusing something)?

nightpool · 2018-12-27T20:16:17Z

@saper jsonb columns can be any json type—arrays, objects, or primitive values.

saper · 2018-12-27T20:17:57Z

Ok, but when ActiveRecord fetches JSONB from PostgreSQL, what do we get? I am just searching for clues related to https://discourse.joinmastodon.org/t/error-on-profile-edit-for-single-user-nomethoderror-undefined-method-for-hash/1563 - I think I am probably on a totally wrong path.

nightpool · 2018-12-27T20:21:47Z

@saper it will return an array for a json array, a hash for a json object, a corresponding rails value (string, number, boolean etc) for json primitive values.

saper · 2018-12-27T20:24:07Z

@saper it will return an array for a json array, a hash for a json object, a corresponding rails value (string, number, boolean etc) for json primitive values.

Thank you!

Gargron added the work in progress Not to be merged, currently being worked on label Mar 5, 2018

Gargron force-pushed the feature-bio-fields branch 2 times, most recently from 50129f9 to 34c8658 Compare March 7, 2018 00:37

Gargron force-pushed the feature-bio-fields branch from 34c8658 to 97911e3 Compare April 10, 2018 15:29

ThisIsMissEm mentioned this pull request Apr 11, 2018

Profile hashtags #5578

Closed

1 task

Gargron added 3 commits April 12, 2018 19:33

Add bio fields

1d1d93f

- Fix #3211 - Fix #232 - Fix #121

Display bio fields in web UI

414cb41

Fix output of links and missing fields

edcac37

Gargron force-pushed the feature-bio-fields branch from 97911e3 to edcac37 Compare April 12, 2018 17:37

Federate bio fields over ActivityPub as PropertyValue

9a7a679

Gargron force-pushed the feature-bio-fields branch 2 times, most recently from 1bfe02e to 251fe66 Compare April 13, 2018 16:02

Gargron removed the work in progress Not to be merged, currently being worked on label Apr 13, 2018

ThisIsMissEm reviewed Apr 13, 2018

View reviewed changes

Gargron force-pushed the feature-bio-fields branch 2 times, most recently from de4289e to 2a4f515 Compare April 13, 2018 17:52

Improve how the fields are stored, add to Edit profile form

0086549

Gargron force-pushed the feature-bio-fields branch from 2a4f515 to 0086549 Compare April 13, 2018 17:55

Add rel=me to links in fields

770596f

Fix #121

Gargron merged commit 78ed4ab into master Apr 14, 2018

Gargron deleted the feature-bio-fields branch April 14, 2018 10:41

S-H-GAMELINKS added a commit to S-H-GAMELINKS/mastodon that referenced this pull request Apr 15, 2018

Revert "Add bio fields (mastodon#6645)"

38ee172

This reverts commit 78ed4ab.

S-H-GAMELINKS added a commit to S-H-GAMELINKS/mastodon that referenced this pull request Apr 16, 2018

Revert "Revert "Add bio fields (mastodon#6645)""

627bf47

This reverts commit 38ee172.

S-H-GAMELINKS added a commit to S-H-GAMELINKS/mastodon that referenced this pull request Apr 16, 2018

Revert "Revert "Revert "Add bio fields (mastodon#6645)"""

b08c0c0

This reverts commit 627bf47.

nightpool mentioned this pull request Apr 16, 2018

[suggestion ] migration error message #7154

Open

2 tasks

sammy8806 mentioned this pull request Apr 25, 2018

Support Account-Fields tuskyapp/Tusky#604

Closed

2 tasks

Gargron mentioned this pull request May 2, 2018

Limit characters in bio fields #7303

Closed

aslmx mentioned this pull request May 26, 2018

[Feature request] Support new Mastodon Profile Meta Data fields TwidereProject/Twidere-Android#1128

Open

aaronpk pushed a commit to indieweb/wiki that referenced this pull request Aug 19, 2018

tantek__ added "Criticism: mastodon/mastodon#6645 (comment)" to "See …

9c9111d

…Also"

mbrubeck mentioned this pull request Aug 20, 2018

Display profile metadata fields nolanlawson/pinafore#454

Closed

saper reviewed Dec 27, 2018

View reviewed changes

Add bio fields #6645

Add bio fields #6645

Gargron commented Mar 5, 2018 •

edited

akihikodaki commented Mar 8, 2018

Gargron commented Mar 8, 2018

akihikodaki commented Mar 8, 2018

Gargron commented Apr 11, 2018

ThisIsMissEm commented Apr 12, 2018

akihikodaki commented Apr 12, 2018

Gargron commented Apr 12, 2018

ThisIsMissEm commented Apr 12, 2018

Gargron commented Apr 12, 2018

ThisIsMissEm commented Apr 12, 2018

ThisIsMissEm Apr 13, 2018

Cassolotl commented Apr 13, 2018

kevinmarks commented Apr 14, 2018

Gargron commented Apr 14, 2018

kevinmarks commented Apr 14, 2018 via email

Wolf480pl commented Apr 14, 2018 •

edited

Gargron commented Apr 14, 2018

Wolf480pl commented Apr 14, 2018

kevinmarks commented Apr 14, 2018 via email

Gargron commented Apr 14, 2018

kevinmarks commented Apr 14, 2018 via email

Gargron commented Apr 14, 2018

saper Dec 27, 2018 •

edited

nightpool commented Dec 27, 2018 via email

saper commented Dec 27, 2018

nightpool commented Dec 27, 2018

saper commented Dec 27, 2018 •

edited

nightpool commented Dec 27, 2018

saper commented Dec 27, 2018

Add bio fields #6645

Add bio fields #6645

Conversation

Gargron commented Mar 5, 2018 • edited

akihikodaki commented Mar 8, 2018

Gargron commented Mar 8, 2018

akihikodaki commented Mar 8, 2018

Gargron commented Apr 11, 2018

ThisIsMissEm commented Apr 12, 2018

akihikodaki commented Apr 12, 2018

Gargron commented Apr 12, 2018

ThisIsMissEm commented Apr 12, 2018

Gargron commented Apr 12, 2018

ThisIsMissEm commented Apr 12, 2018

ThisIsMissEm Apr 13, 2018

Choose a reason for hiding this comment

Cassolotl commented Apr 13, 2018

kevinmarks commented Apr 14, 2018

Gargron commented Apr 14, 2018

kevinmarks commented Apr 14, 2018 via email

Wolf480pl commented Apr 14, 2018 • edited

Gargron commented Apr 14, 2018

Wolf480pl commented Apr 14, 2018

kevinmarks commented Apr 14, 2018 via email

Gargron commented Apr 14, 2018

kevinmarks commented Apr 14, 2018 via email

Gargron commented Apr 14, 2018

saper Dec 27, 2018 • edited

Choose a reason for hiding this comment

nightpool commented Dec 27, 2018 via email

saper commented Dec 27, 2018

nightpool commented Dec 27, 2018

saper commented Dec 27, 2018 • edited

nightpool commented Dec 27, 2018

saper commented Dec 27, 2018

Gargron commented Mar 5, 2018 •

edited

Wolf480pl commented Apr 14, 2018 •

edited

saper Dec 27, 2018 •

edited

saper commented Dec 27, 2018 •

edited