tangled.org / core
Monorepo for Tangled tangled.org
fork atom

appview: allows a default knot to be configured #991

open opened by willdot.net targeting master from willdot.net/tangled-fork: default-knot

This follows on from the work carried out in #836

I've added a select box in the Knots settings page which pulls in the users knots and also adds in knot1.tangled.sh. When the user selects one of these options, it will save to their profile in the database. NOTE: I haven't yet implemented adding that to the AT record because I'm not sure on how the lexicon setup works yet!

Then when users go to create a new repo / fork, if there is a value in their profile for the default knot, then that will pre select the knot to use for the new repo / fork.

This is a duplicate of https://tangled.org/tangled.org/core/pulls/858/ which had to be closed because there were merge conflicts which couldn't be resolved due to the origin fork being deleted 🙈

Labels

None yet.

assignee

None yet.

Participants 2
AT URI
at://did:plc:dadhhalkfcq3gucaq25hjqon/sh.tangled.repo.pull/3mcrzfonnxs22
+78 -53
Interdiff #4 → #5
unified split
+6 -7
appview/db/db.go
··· 567 unique (from_at, to_at) 568 ); 569 570 create table if not exists migrations ( 571 id integer primary key autoincrement, 572 name text unique ··· 1173 return err 1174 }) 1175 1176 - orm.RunMigration(conn, logger, "add-default-knot-profile", func(tx *sql.Tx) error { 1177 - _, err := tx.Exec(` 1178 - alter table profile add column default_knot text; 1179 - `) 1180 - return err 1181 - }) 1182 - 1183 return &DB{ 1184 db, 1185 logger,
··· 567 unique (from_at, to_at) 568 ); 569 570 + create table if not exists knot_preferences ( 571 + id integer primary key autoincrement, 572 + user_did text not null unique, 573 + default_knot text 574 + ); 575 + 576 create table if not exists migrations ( 577 id integer primary key autoincrement, 578 name text unique ··· 1179 return err 1180 }) 1181 1182 return &DB{ 1183 db, 1184 logger,
+3 -10
appview/db/profile.go
··· 141 pronouns, 142 default_knot 143 ) 144 - values (?, ?, ?, ?, ?, ?)`, 145 profile.Did, 146 profile.Description, 147 includeBskyValue, 148 profile.Location, 149 profile.Pronouns, 150 - profile.DefaultKnot, 151 ) 152 153 if err != nil { ··· 326 func GetProfile(e Execer, did string) (*models.Profile, error) { 327 var profile models.Profile 328 var pronouns sql.Null[string] 329 - var defaultKnot sql.Null[string] 330 - 331 profile.Did = did 332 333 includeBluesky := 0 334 335 err := e.QueryRow( 336 - `select description, include_bluesky, location, pronouns, default_knot from profile where did = ?`, 337 did, 338 - ).Scan(&profile.Description, &includeBluesky, &profile.Location, &pronouns, &defaultKnot) 339 if err == sql.ErrNoRows { 340 profile := models.Profile{} 341 profile.Did = did ··· 354 profile.Pronouns = pronouns.V 355 } 356 357 - if defaultKnot.Valid { 358 - profile.DefaultKnot = defaultKnot.V 359 - } 360 - 361 rows, err := e.Query(`select link from profile_links where did = ?`, did) 362 if err != nil { 363 return nil, err
··· 141 pronouns, 142 default_knot 143 ) 144 + values (?, ?, ?, ?, ?)`, 145 profile.Did, 146 profile.Description, 147 includeBskyValue, 148 profile.Location, 149 profile.Pronouns, 150 ) 151 152 if err != nil { ··· 325 func GetProfile(e Execer, did string) (*models.Profile, error) { 326 var profile models.Profile 327 var pronouns sql.Null[string] 328 profile.Did = did 329 330 includeBluesky := 0 331 332 err := e.QueryRow( 333 + `select description, include_bluesky, location, pronouns from profile where did = ?`, 334 did, 335 + ).Scan(&profile.Description, &includeBluesky, &profile.Location, &pronouns) 336 if err == sql.ErrNoRows { 337 profile := models.Profile{} 338 profile.Did = did ··· 351 profile.Pronouns = pronouns.V 352 } 353 354 rows, err := e.Query(`select link from profile_links where did = ?`, did) 355 if err != nil { 356 return nil, err
+4 -4
appview/knots/knots.go
··· 89 } 90 91 defaultKnot := "" 92 - profile, err := db.GetProfile(k.Db, user.Did()) 93 if err != nil { 94 - k.Logger.Warn("gettings user profile to get default knot", "error", err) 95 } 96 - if profile != nil { 97 - defaultKnot = profile.DefaultKnot 98 } 99 100 k.Pages.Knots(w, pages.KnotsParams{
··· 89 } 90 91 defaultKnot := "" 92 + knotPrefence, err := db.GetKnotPreference(k.Db, user.Did()) 93 if err != nil { 94 + k.Logger.Warn("gettings users knot preferences", "error", err) 95 } 96 + if knotPrefence != nil { 97 + defaultKnot = knotPrefence.DefaultKnot 98 } 99 100 k.Pages.Knots(w, pages.KnotsParams{
-1
appview/models/profile.go
··· 20 Stats [2]VanityStat 21 PinnedRepos [6]syntax.ATURI 22 Pronouns string 23 - DefaultKnot string 24 } 25 26 func (p Profile) IsLinksEmpty() bool {
··· 20 Stats [2]VanityStat 21 PinnedRepos [6]syntax.ATURI 22 Pronouns string 23 } 24 25 func (p Profile) IsLinksEmpty() bool {
appview/pages/pages.go

This file has not been changed.

appview/pages/templates/knots/index.html

This file has not been changed.

appview/pages/templates/repo/fork.html

This file has not been changed.

appview/pages/templates/repo/new.html

This file has not been changed.

+4 -4
appview/repo/repo.go
··· 1005 } 1006 1007 defaultKnot := "" 1008 - profile, err := db.GetProfile(rp.db, user.Did()) 1009 if err != nil { 1010 - rp.logger.Warn("gettings user profile to get default knot", "error", err) 1011 } 1012 - if profile != nil { 1013 - defaultKnot = profile.DefaultKnot 1014 } 1015 1016 rp.pages.ForkRepo(w, pages.ForkRepoParams{
··· 1005 } 1006 1007 defaultKnot := "" 1008 + knotPrefence, err := db.GetKnotPreference(rp.db, user.Did()) 1009 if err != nil { 1010 + rp.logger.Warn("gettings users knot preferences", "error", err) 1011 } 1012 + if knotPrefence != nil { 1013 + defaultKnot = knotPrefence.DefaultKnot 1014 } 1015 1016 rp.pages.ForkRepo(w, pages.ForkRepoParams{
+5 -22
appview/state/profile.go
··· 616 s.updateProfile(profile, w, r) 617 } 618 619 - func (s *State) UpdateProfileDefaultKnot(w http.ResponseWriter, r *http.Request) { 620 err := r.ParseForm() 621 if err != nil { 622 - log.Println("invalid profile update form", err) 623 - return 624 - } 625 - user := s.oauth.GetUser(r) 626 - 627 - profile, err := db.GetProfile(s.db, user.Did) 628 - if err != nil { 629 - log.Printf("getting profile data for %s: %s", user.Did, err) 630 - } 631 - 632 - if profile == nil { 633 return 634 } 635 636 defaultKnot := r.Form.Get("default-knot") 637 ··· 639 defaultKnot = "" 640 } 641 642 - profile.DefaultKnot = defaultKnot 643 - 644 - tx, err := s.db.BeginTx(r.Context(), nil) 645 - if err != nil { 646 - log.Println("failed to start transaction", err) 647 - return 648 - } 649 - 650 - err = db.UpsertProfile(tx, profile) 651 if err != nil { 652 - log.Println("failed to update profile", err) 653 return 654 } 655
··· 616 s.updateProfile(profile, w, r) 617 } 618 619 + func (s *State) UpdateDefaultKnotPreference(w http.ResponseWriter, r *http.Request) { 620 err := r.ParseForm() 621 if err != nil { 622 + log.Println("invalid preference update form", err) 623 return 624 } 625 + user := s.oauth.GetMultiAccountUser(r) 626 627 defaultKnot := r.Form.Get("default-knot") 628 ··· 630 defaultKnot = "" 631 } 632 633 + err = db.UpsertKnotPreference(s.db, user.Did(), defaultKnot) 634 if err != nil { 635 + log.Println("failed to update default knot preference", err) 636 return 637 } 638
+1 -1
appview/state/router.go
··· 165 r.Get("/edit-pins", s.EditPinsFragment) 166 r.Post("/bio", s.UpdateProfileBio) 167 r.Post("/pins", s.UpdateProfilePins) 168 - r.Post("/default-knot", s.UpdateProfileDefaultKnot) 169 }) 170 171 r.Mount("/settings", s.SettingsRouter())
··· 165 r.Get("/edit-pins", s.EditPinsFragment) 166 r.Post("/bio", s.UpdateProfileBio) 167 r.Post("/pins", s.UpdateProfilePins) 168 + r.Post("/default-knot", s.UpdateDefaultKnotPreference) 169 }) 170 171 r.Mount("/settings", s.SettingsRouter())
+6 -4
appview/state/state.go
··· 418 return 419 } 420 421 defaultKnot := "" 422 - profile, err := db.GetProfile(s.db, user.Did()) 423 if err != nil { 424 - s.logger.Warn("gettings user profile to get default knot", "error", err) 425 } 426 - if profile != nil { 427 - defaultKnot = profile.DefaultKnot 428 } 429 430 s.pages.NewRepo(w, pages.NewRepoParams{
··· 418 return 419 } 420 421 + knots = append(knots, "hello") 422 + 423 defaultKnot := "" 424 + knotPrefence, err := db.GetKnotPreference(s.db, user.Did()) 425 if err != nil { 426 + s.logger.Warn("gettings users knot preferences", "error", err) 427 } 428 + if knotPrefence != nil { 429 + defaultKnot = knotPrefence.DefaultKnot 430 } 431 432 s.pages.NewRepo(w, pages.NewRepoParams{
+42
appview/db/preferences.go
···
··· 1 + package db 2 + 3 + import ( 4 + "database/sql" 5 + 6 + "tangled.org/core/appview/models" 7 + ) 8 + 9 + func GetKnotPreference(e Execer, did string) (*models.KnotPreference, error) { 10 + var knotPreference models.KnotPreference 11 + 12 + err := e.QueryRow( 13 + `select id, user_did, default_knot from knot_preferences where user_did = ?`, 14 + did, 15 + ).Scan(&knotPreference.ID, &knotPreference.Did, &knotPreference.DefaultKnot) 16 + if err == sql.ErrNoRows { 17 + return nil, nil 18 + } 19 + 20 + if err != nil { 21 + return nil, err 22 + } 23 + 24 + return &knotPreference, nil 25 + } 26 + 27 + func UpsertKnotPreference(e Execer, did, defaultKnot string) error { 28 + _, err := e.Exec( 29 + `insert or replace into knot_preferences ( 30 + user_did, 31 + default_knot 32 + ) 33 + values (?, ?)`, 34 + did, 35 + defaultKnot, 36 + ) 37 + if err != nil { 38 + return err 39 + } 40 + 41 + return nil 42 + }
+7
appview/models/preferences.go
···
··· 1 + package models 2 + 3 + type KnotPreference struct { 4 + ID int 5 + Did string 6 + DefaultKnot string 7 + }

History

8 rounds 9 comments
sign up or login to add to the discussion
willdot.net submitted #7
diff interdiff
1 commit
expand
361559b7
appview: allow default knot to be saved as a preference and then used when creating a new repo
no conflicts, ready to merge
expand 0 comments
willdot.net submitted #6
diff interdiff
1 commit
expand
10fdc2cf
appview: allow default knot to be saved as a preference and then used when creating a new repo
expand 0 comments
willdot.net submitted #5
interdiff
1 commit
expand
8f3e1061
appview: allow default knot to be saved as a preference and then used when creating a new repo
expand 0 comments
willdot.net submitted #4
diff interdiff
1 commit
expand
64142e65
appview: allows a default knot to be selected from knots available to the user
expand 5 comments
willdot.net

@oppi.li While attempting to implement something else related to profiles, I've noticed that UpsertProfile(...) herehttps://tangled.org/tangled.org/core/blob/master/appview/db/profile.go#L133 also gets called as part of a JS ingester here https://tangled.org/tangled.org/core/blob/master/appview/ingester.go#L352 which means the DefaultKnot field will be overwritten with an empty string when a profile event is ingested. Am I understanding that correctly?

So instead I should probably not use the UpsertProfile(...) but use a smaller scoped function that just sets the Default Knot field?

oppi.li

ah that is correct, the default knot will be overwritten by that call. i suppose that is one of the drawbacks of overloading models.Profile! instead of cloning UpsertProfile to add this as an exception, perhaps this is an indication that we need to avoid using the profile table/model for this. what do you think about creating a preferences table for stuff like this? we already have notification_preferences, we could do something similar for knots.

i see you have a PR open for punchcard work as well, which would fit quite well in a punchcard_preferences table.

willdot.net

Yh I'm 100% down for using that approach. While I was implementing the punchcard PR I had this nagging feeling in me that this and other things belonged in some sort of separate "preferences" table so splitting them out into things like knot_preferences or punchcard_preferences is the right answer for me.

I'll redo that for this PR and then do the same of the other PR and hopefully it will prevent the merge conflicts I was dreading 🙈

oppi.li

yeah! knot_preferences and punchcard_preferences seems okay for now. thanks for keeping at this by the way, and sorry for the slow review cycle!

willdot.net

No worries! I don't expect immediate reviews 😁

I've refactored to use a new knot_preferences table for this PR. I had some merge conflicts with master though, so rebased that although took me a couple attempts to get everything nice and neat, hence so many rounds 🙈

willdot.net submitted #3
diff interdiff
2 commits
expand
9a142873
appview: allows a default knot to be configured
7000e5e6
appview: allows a default knot to be selected from knots available to the user
expand 0 comments
willdot.net submitted #2
diff interdiff
1 commit
expand
9a142873
appview: allows a default knot to be configured
expand 2 comments
oppi.li

the code itself works pretty nicely now. so i've noticed a couple issues (apologies for not looking more closely earlier!):

  • the default-knot selector only iterates over knots that the user is an admin of, whereas they should be able to choose any knot that they are a member of as the default. you can use s.enforcer.GetKnotsForUser(...) to get a list of knots that a user has access to
  • the HTML change adds knot1.tangled.sh as an explicit case, this is not necessary if the above is implemented
  • the HTML template currently triggers a request when the select changes, could we make this more like how the spindle selector works? a form with a button to submit.
willdot.net

I was looking for ages trying to find somewhere that did something similar. I don't use spindles so never saw that 🙈 A much better approach.

Also good shout on the knots for a user. Reading the code now, I understand what the registrations are now.

Anyhow, I've updated the PR and squashed everything so it should be good to test now.

Please note, that I have yet to figure out how to get multiple Knots running locally, and since I don't get knot1.tangled.sh locally I had to hard code some things in to test it worked, which is less than ideal.

willdot.net submitted #1
diff interdiff
1 commit
expand
d48b01e5
appview: allows a default knot to be configured
expand 0 comments
willdot.net submitted #0
diff
1 commit
expand
5ffb8261
appview: allows a default knot to be configured
expand 2 comments
oppi.li

i get this error at runtime:

2026/01/20 04:58:12 profile err 5 values for 6 columns
2026/01/20 04:58:12 failed to update profile 5 values for 6 columns

this sql query is incorrect:

		`insert or replace into profile (
			did,
			description,
			include_bluesky,
			location,
			pronouns,
			default_knot
		)
		values (?, ?, ?, ?, ?)`,

there should be 6 ? placeholders!

willdot.net

Ah crap, someone needs to create a lint tool that detects that 🤦‍♂️

Fixed.